文档

GetUser - 查询用户信息

更新时间:
一键部署

调用GetUser查询指定用户信息。

调试

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

授权信息

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

请求参数

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

用户 ID。

u-00q8wbq42wiltcrk****
DirectoryIdstring

目录 ID。

d-00fc2p61****

返回参数

名称类型描述示例值
object

返回结果。

Userobject

用户信息。

Statusstring

用户的状态。取值:

  • Enabled:启用。
  • Disabled:禁用。
Enabled
UserNamestring

用户名称。

Alice
Emailstring

用户的电子邮箱。

Alice@example.com
Descriptionstring

用户的描述。

This is a user.
UserIdstring

用户 ID。

u-00q8wbq42wiltcrk****
FirstNamestring

用户的名。

Alice
CreateTimestring

用户的创建时间(UTC 时间)。

2021-10-26T03:03:42Z
ProvisionTypestring

用户的类型。取值:

  • Manual:手动创建。
  • Synchronized:外部同步。
Manual
DisplayNamestring

用户的显示名称。

Alice
UpdateTimestring

用户的修改时间(UTC 时间)。

2021-10-26T06:43:55Z
LastNamestring

用户的姓。

Lee
ExternalIdobject

外部身份提供商的用户标识符信息。

Idstring

外部身份提供商的用户标识符。

c73******a5fdd5
Issuerstring

外部身份同步渠道,当前仅支持 SCIM 同步。

SCIM
RequestIdstring

请求 ID。

EE42D2C4-A30A-59B7-ACEB-6D22FB44174A

示例

正常返回示例

JSON格式

{
  "User": {
    "Status": "Enabled",
    "UserName": "Alice",
    "Email": "Alice@example.com",
    "Description": "This is a user.",
    "UserId": "u-00q8wbq42wiltcrk****",
    "FirstName": "Alice",
    "CreateTime": "2021-10-26T03:03:42Z",
    "ProvisionType": "Manual",
    "DisplayName": "Alice",
    "UpdateTime": "2021-10-26T06:43:55Z",
    "LastName": "Lee",
    "ExternalId": {
      "Id": "c73******a5fdd5",
      "Issuer": "SCIM"
    }
  },
  "RequestId": "EE42D2C4-A30A-59B7-ACEB-6D22FB44174A"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)