查询便捷用户信息,例如便捷用户的用户名、邮箱地址、备注名称等等。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
MaxResults | long | 否 | 分页查询时每页行数。
| 10 |
NextToken | string | 否 | 下一次查询的 Token。首次调用接口时无需设置该参数。 | caeba0bbb2be03f84eb48b699f0a**** |
Filter | string | 否 | 模糊搜索字符串,支持匹配用户名(EndUserId)和邮箱(Email)。该字段支持使用通配符(*),例如将该字段设为 | a*m |
EndUserIds | array | 否 | 需精确匹配的用户名(EndUserId)列表。 | |
string | 否 | 按用户名(EndUserId)精确匹配,查询用户名一致的用户信息。 | alice | |
ExcludeEndUserIds | array | 否 | 需精确排除的用户名(EndUserId)列表。 | |
string | 否 | 按用户名(EndUserId)精确排除,查询不包含该用户名的用户列表。 | tony | |
OrgId | string | 否 | 按组织 ID 精确匹配,查询归属该组织的用户列表。 | org-4mdgc1cocc59z**** |
GroupId | string | 否 | 按用户组 ID 精确匹配,查询归属该用户组的用户列表。 | ug-12341234**** |
返回参数
示例
正常返回示例
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-24 | OpenAPI 入参发生变更 | 看变更集 | ||||||
| ||||||||
2023-12-11 | OpenAPI 入参发生变更 | 看变更集 | ||||||
| ||||||||
2023-09-24 | OpenAPI 入参发生变更、OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2023-08-06 | OpenAPI 返回结构发生变更 | 看变更集 | ||||||
| ||||||||
2021-04-02 | 新增 OpenAPI | 看变更集 |