获取用户信息

最近更新时间:2024-03-12 01:29:47

我的收藏

1. 接口描述

接口请求域名: eiam.tencentcloudapi.com 。

通过用户名或用户 id 搜索用户

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserInfo。
Version String 公共参数,本接口取值:2021-04-20。
Region String 公共参数,本接口不需要传递此参数。
UserName String 用户名,长度限制:64个字符。 Username 和 UserId 需至少一个不为空;都不为空时优先使用 Username。
UserId String 用户 id,长度限制:64个字符。 Username 和 UserId 需至少一个不为空;都不为空时优先使用 Username。
示例值:id

3. 输出参数

参数名称 类型 描述
UserName String 用户名。
注意:此字段可能返回 null,表示取不到有效值。
Status String 用户状态,取值 NORMAL (正常)、FREEZE (已冻结)、LOCKED (已锁定)或 NOT_ENABLED (未启用)。
注意:此字段可能返回 null,表示取不到有效值。
DisplayName String 昵称。
注意:此字段可能返回 null,表示取不到有效值。
Description String 用户备注。
注意:此字段可能返回 null,表示取不到有效值。
UserGroupIds Array of String 用户所属用户组 id 列表。
注意:此字段可能返回 null,表示取不到有效值。
UserId String 用户 id,长度限制:64个字符。
注意:此字段可能返回 null,表示取不到有效值。
示例值:id
Email String 用户邮箱。
注意:此字段可能返回 null,表示取不到有效值。
Phone String 用户手机号。
注意:此字段可能返回 null,表示取不到有效值。
OrgNodeId String 用户所属的主组织机构唯一ID。
注意:此字段可能返回 null,表示取不到有效值。
DataSource String 数据来源。
注意:此字段可能返回 null,表示取不到有效值。
ExpirationTime String 用户过期时间,遵循 ISO 8601 标准。
注意:此字段可能返回 null,表示取不到有效值。
ActivationTime String 用户激活时间,遵循 ISO 8601 标准。
注意:此字段可能返回 null,表示取不到有效值。
PwdNeedReset Boolean 当前用户的密码是否需要重置,该字段为false表示不需要重置密码。
注意:此字段可能返回 null,表示取不到有效值。
SecondaryOrgNodeIdList Array of String 用户所属的次要组织机构ID列表。
注意:此字段可能返回 null,表示取不到有效值。
AdminFlag Integer 是否管理员标志,0为否、1为是。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

POST / HTTP/1.1
Host: eiam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeUserInfo
<公共请求参数>

{
    "UserName": "xxx"
}

输出示例

{
    "Response": {
        "UserName": "xx",
        "Status": "xx",
        "DisplayName": "xx",
        "Description": "xx",
        "SecondaryOrgNodeIdList": [
            "xx"
        ],
        "UserGroupIds": [
            "xx",
            "xx"
        ],
        "AdminFlag": 1,
        "UserId": "xx",
        "Phone": "xx",
        "OrgNodeId": "xx",
        "DataSource": "xx",
        "Email": "xx",
        "ExpirationTime": "xx",
        "ActivationTime": "xx",
        "PwdNeedReset": true,
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.OperationError 操作失败。
FailedOperation.PersonNotFound 身份主体未找到。
InvalidParameter.UserNameIsNull 用户名参数为空。
InvalidParameterValue.ParameterIllegal 参数不合法。
InvalidParameterValue.UserIdCanNotBeEmpty 用户ID不能为空。
InvalidParameterValue.UserNameCanNotBeEmpty 用户名不能为空。