文档

GetUser - 查询一个EIAM账户信息

查询一个EIAM账户详情信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:GetUserRead
  • 全部资源
    acs:eiam:{#regionId}:{#accountId}:*

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
UserIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

返回参数

名称类型描述示例值
object

响应结果。

RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
Userobject

账户对象数据。

UserIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx
Usernamestring

账户名。

name001
DisplayNamestring

账户显示名。

display_name001
PasswordSetboolean

密码是否已设置

false
PhoneRegionstring

手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +。

86
PhoneNumberstring

账户手机号码。

156xxxxxxx
PhoneNumberVerifiedboolean

手机号是否已验证,true 表示手机号已经过用户验证或被管理员设置为已验证,false 表示未验证。

true
Emailstring

账户邮箱。

user@example.com
EmailVerifiedboolean

邮箱是否已验证,true 表示邮箱已经过用户的验证或被管理员设置为已验证,false 表示未验证。

true
UserExternalIdstring

账户外部 ID,用于外部数据与 IDaaS 账户的数据关联映射,默认为 IDaaS 账户 ID。

说明:外部 ID 在同一来源类型和来源 ID 下唯一。

user_d6sbsuumeta4h66ec3il7yxxxx
UserSourceTypestring

账户来源类型,取值可选范围:

  • build_in:自建。

  • ding_talk:钉钉导入。

  • ad:AD 导入。

  • ldap:LDAP 导入。

  • we_com:企业微信导入。

build_in
UserSourceIdstring

账户来源 ID。

自建类型默认为实例 ID,其他类型,分别对应不同来源的企业 ID,比如钉钉来源对应钉钉企业的 corpId。

idaas_ue2jvisn35ea5lmthk267xxxxx
Statusstring

账户状态,取值可选范围:

  • enabled:启用中。

  • disabled:禁用中。

enabled
AccountExpireTimelong

账户过期时间,Unix 时间戳格式,单位为毫秒。

1652085686179
PasswordExpireTimelong

密码过期时间,Unix 时间戳格式,单位为毫秒。

  • 当返回值为-1 时表示密码不过期

  • 当无返回值时表示密码不过期

  • 当返回值为具体的时间戳格式时表示具体的密码过期时间

1652085686179
RegisterTimelong

账户注册时间,Unix 时间戳格式,单位为毫秒。

1652085686179
LockExpireTimelong

锁定过期时间,Unix 时间戳格式,单位为毫秒。

1652085686179
CreateTimelong

账户创建时间,Unix 时间戳格式,单位为毫秒。

1652085686179
UpdateTimelong

账户最近一次更新时间,Unix 时间戳格式,单位为毫秒。

1652085686179
Descriptionstring

账户描述信息。

测试账户
OrganizationalUnitsobject []

账户所属组织列表。

OrganizationalUnitIdstring

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
OrganizationalUnitNamestring

组织名称。

test_ou_name
Primaryboolean

是否主组织。

true
PrimaryOrganizationalUnitIdstring

账户所属主组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
CustomFieldsobject []

账户扩展字段列表

FieldNamestring

扩展字段标识。

age
FieldValuestring

扩展字段数据值。

10
Groupsobject []

账户所属组对象列表。

GroupIdstring

组 ID。

group_d6sbsuumeta4h66ec3il7yxxxx
GroupNamestring

组名称。

group_test_name
Descriptionstring

组描述。

this is a test.
InstanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
PreferredLanguagestring

偏好语言

en-US

示例

正常返回示例

JSON格式

{
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "User": {
    "UserId": "user_d6sbsuumeta4h66ec3il7yxxxx",
    "Username": "name001",
    "DisplayName": "display_name001",
    "PasswordSet": false,
    "PhoneRegion": "86",
    "PhoneNumber": "156xxxxxxx",
    "PhoneNumberVerified": true,
    "Email": "user@example.com",
    "EmailVerified": true,
    "UserExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
    "UserSourceType": "build_in",
    "UserSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "Status": "enabled",
    "AccountExpireTime": 1652085686179,
    "PasswordExpireTime": 1652085686179,
    "RegisterTime": 1652085686179,
    "LockExpireTime": 1652085686179,
    "CreateTime": 1652085686179,
    "UpdateTime": 1652085686179,
    "Description": "测试账户",
    "OrganizationalUnits": [
      {
        "OrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
        "OrganizationalUnitName": "test_ou_name",
        "Primary": true
      }
    ],
    "PrimaryOrganizationalUnitId": "ou_wovwffm62xifdziem7an7xxxxx",
    "CustomFields": [
      {
        "FieldName": "age",
        "FieldValue": "10"
      }
    ],
    "Groups": [
      {
        "GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
        "GroupName": "group_test_name",
        "Description": "this is a test."
      }
    ],
    "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
    "PreferredLanguage": "en-US"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-03-12OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2023-03-21OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈