文档

DescribeUsers - 查询便捷用户信息

更新时间:

查询便捷用户信息,例如便捷用户的用户名、邮箱地址、备注名称等等。

调试

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

授权信息

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

请求参数

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

分页查询时每页行数。

  • 取值范围:1~500。
  • 默认值:500。
10
NextTokenstring

下一次查询的 Token。首次调用接口时无需设置该参数。
如果一次查询结果并没有完整返回所有的结果,则返回的 NextToken 不为空。您可以在查询中上传返回的 NextToken 继续查询。

caeba0bbb2be03f84eb48b699f0a****
Filterstring

模糊搜索字符串,支持匹配用户名(EndUserId)和邮箱(Email)。该字段支持使用通配符(*),例如将该字段设为a*m,则返回用户名或邮箱以a开头、以m结尾的所有结果。

a*m
EndUserIdsarray

需精确匹配的用户名(EndUserId)列表。

string

按用户名(EndUserId)精确匹配,查询用户名一致的用户信息。

alice
ExcludeEndUserIdsarray

需精确排除的用户名(EndUserId)列表。

string

按用户名(EndUserId)精确排除,查询不包含该用户名的用户列表。

tony
OrgIdstring

按组织 ID 精确匹配,查询归属该组织的用户列表。

org-4mdgc1cocc59z****
GroupIdstring

按用户组 ID 精确匹配,查询归属该用户组的用户列表。

ug-12341234****

返回参数

名称类型描述示例值
object

返回信息集合。

RequestIdstring

请求 ID。

1CBAFFAB-B697-4049-A9B1-67E1FC5F****
NextTokenstring

下一次查询的 Token。NextToken 为空表示没有下一次。

caeba0bbb2be03f84eb48b699f0a4883
Usersobject []

便捷用户信息集合。

Idlong

用户 ID。

4205**
EndUserIdstring

用户名。

alice
Emailstring

邮箱。

username@example.com
Phonestring

手机号,如未设置该参数则不返回该参数。

1381111****
Statuslong

状态。

枚举值:
  • 0正常
  • 9锁定
0
OwnerTypestring

便捷账号类型,包括:

  • 管理员激活类型,管理员设置用户名及用户密码,重置密码等用户通知将发送到管理员的邮箱或手机。
  • 用户激活类型,管理员设置用户名及用户接收通知的邮件或手机,云桌面开通通知(含初始密码)等用户通知将发送到用户的邮件或手机。
Normal
Remarkstring

用户的备注。

测试专用用户
OrgIdstring

用户归属的部门 ID。

说明 该参数即将废弃。
org-4mdgc1cocc59z****
WyIdstring

用户全局唯一 ID。

41fd1254d8f7****
IsTenantManagerboolean

是否为用户管理员。如果创建的便捷用户是管理员激活类型,则必须指定一位用户管理员,终端用户通过客户端重置密码等通知将发送到该用户管理员的邮箱或手机,详情参见创建便捷用户

true
Groupsobject []

用户归属的用户组集合。

GroupIdstring

用户组 ID。

ug-12341234****
GroupNamestring

用户组名称。

用户组1
Orgsobject []

用户归属的部门集合。

OrgIdstring

部门 ID。

org-4mdgc1cocc59z****
OrgNamestring

部门名称。

部门1
Avatarstring

用户头像。

https://cdn.*****
Addressstring

用户工作地址。

杭州市***
JobNumberstring

用户工号。

A10000**
NickNamestring

用户昵称。

李**

示例

正常返回示例

JSON格式

{
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Users": [
    {
      "Id": 0,
      "EndUserId": "alice",
      "Email": "username@example.com",
      "Phone": "1381111****",
      "Status": 0,
      "OwnerType": "Normal",
      "Remark": "测试专用用户",
      "OrgId": "org-4mdgc1cocc59z****",
      "WyId": "41fd1254d8f7****",
      "IsTenantManager": true,
      "Groups": [
        {
          "GroupId": "ug-12341234****",
          "GroupName": "用户组1"
        }
      ],
      "Orgs": [
        {
          "OrgId": "org-4mdgc1cocc59z****",
          "OrgName": "部门1"
        }
      ],
      "Avatar": "https://cdn.*****",
      "Address": "杭州市***",
      "JobNumber": "A10000**",
      "NickName": "李**"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-01-24OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    删除入参:BizType
    删除入参:SolutionId
2023-12-11OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:BizType
    新增入参:SolutionId
2023-09-24OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:GroupId
出参OpenAPI 返回结构发生变更
2023-08-06OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-04-02新增 OpenAPI看变更集
  • 本页导读 (0)