GetUser - 查询一个EIAM账户信息

更新时间:
复制 MD 格式

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

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

UserId

string

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

返回参数

名称

类型

描述

示例值

object

响应结果。

RequestId

string

请求 ID。

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

User

object

账户对象数据。

UserId

string

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

Username

string

账户名。

name001

DisplayName

string

账户显示名。

display_name001

PasswordSet

boolean

密码是否已设置

false

PhoneRegion

string

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

86

PhoneNumber

string

账户手机号码。

156xxxxxxx

PhoneNumberVerified

boolean

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

true

Email

string

账户邮箱。

user@example.com

EmailVerified

boolean

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

true

UserExternalId

string

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

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

user_d6sbsuumeta4h66ec3il7yxxxx

UserSourceType

string

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

  • build_in:自建。

  • ding_talk:钉钉导入。

  • ad:AD 导入。

  • ldap:LDAP 导入。

  • we_com:企业微信导入。

build_in

UserSourceId

string

账户来源 ID。

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

idaas_ue2jvisn35ea5lmthk267xxxxx

Status

string

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

  • enabled:启用中。

  • disabled:禁用中。

enabled

AccountExpireTime

integer

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

1652085686179

PasswordExpireTime

integer

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

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

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

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

1652085686179

RegisterTime

integer

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

1652085686179

LockExpireTime

integer

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

1652085686179

CreateTime

integer

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

1652085686179

UpdateTime

integer

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

1652085686179

Description

string

账户描述信息。

Test account

OrganizationalUnits

array<object>

账户所属组织列表。

object

组织对象信息。

OrganizationalUnitId

string

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx

OrganizationalUnitName

string

组织名称。

test_ou_name

Primary

boolean

是否主组织。

true

PrimaryOrganizationalUnitId

string

账户所属主组织 ID。

ou_wovwffm62xifdziem7an7xxxxx

CustomFields

array<object>

账户扩展字段列表

object

扩展字段对象。

FieldName

string

扩展字段标识。

age

FieldValue

string

扩展字段数据值。

10

Groups

array<object>

账户所属组对象列表。

object

账户所属组对象。

GroupId

string

组 ID。

group_d6sbsuumeta4h66ec3il7yxxxx

GroupName

string

组名称。

group_test_name

Description

string

组描述。

this is a test.

InstanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

PreferredLanguage

string

偏好语言

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": "Test account",
    "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"
  }
}

错误码

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

变更历史

更多信息,参考变更详情