调用ListUsers接口，分页查询EIAM账户信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /v2/{instanceId}/{applicationId}/users HTTP/1.1请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| Authorization |
string |
是 |
认证信息。 格式：Bearer ${access_token}。 示例：Bearer ATxxxx。 |
Bearer AT8csE2seYxxxxxij |
| instanceId |
string |
是 |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
是 |
应用 ID。 |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
| organizationalUnitId |
string |
否 |
组织 ID。 |
ou_wovwffm62xifdziem7an7xxxxx |
| pageNumber |
integer |
否 |
页码，默认 1。 |
1 |
| pageSize |
integer |
否 |
单页大小读取记录数，默认 20，范围为 1～100。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应结果。 |
||
| totalCount |
integer |
数据总记录数。 |
1000 |
| data |
array<object> |
返回数据对象列表。 |
|
|
object |
返回数据对象。 |
||
| instanceId |
string |
实例 ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| userId |
string |
账户 ID。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| username |
string |
账户名。 |
name001 |
| displayName |
string |
账户显示名。 |
display_name001 |
| passwordSet |
boolean |
密码是否已设置 |
true |
| phoneRegion |
string |
手机地区编号,示例：中国大陆手区号为 86，不带 00 或 +。 |
86 |
| phoneNumber |
string |
账户手机号。 |
156xxxxxxx |
| phoneNumberVerified |
boolean |
手机号是否已验证，true 表示手机号已经过用户验证或被管理员设置为已验证，false 表示未验证。 |
true |
|
string |
账户邮箱。 |
example@example.com |
|
| emailVerified |
boolean |
邮箱是否已验证，true 表示邮箱已经过用户的验证或被管理员设置为已验证，false 表示未验证 |
true |
| userExternalId |
string |
账户外部 ID，用于外部数据与 IDaaS 账户的数据关联映射，默认为 IDaaS 账户 ID。 说明：外部 ID 在同一来源类型和来源 ID 下唯一。 |
user_d6sbsuumeta4h66ec3il7yxxxx |
| userSourceType |
string |
账户来源类型，取值可选范围：
|
build_in |
| userSourceId |
string |
账户来源 ID。 自建类型默认为实例 ID，其他类型，分别对应不同来源的企业 ID，比如钉钉来源对应钉钉企业的 corpId。 |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| status |
string |
账户状态，取值可选范围： enabled - 启用中。 disabled - 禁用中。 |
enabled |
| accountExpireTime |
integer |
账户过期时间，Unix 时间戳格式，单位为毫秒。 |
1652085686179 |
| registerTime |
integer |
账户注册时间，Unix 时间戳格式，单位为毫秒。 |
1652085686179 |
| lockExpireTime |
integer |
账户锁定过期时间，Unix 时间戳格式，单位为毫秒。 |
1652085686179 |
| createTime |
integer |
账户创建时间，Unix 时间戳格式，单位为毫秒。 |
1652085686179 |
| updateTime |
integer |
账户最近一次更新时间，Unix 时间戳格式，单位为毫秒。 |
1652085686179 |
| description |
string |
账户描述。 |
测试账户 |
示例
正常返回示例
JSON格式
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"userId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"username": "name001",
"displayName": "display_name001",
"passwordSet": true,
"phoneRegion": "86",
"phoneNumber": "156xxxxxxx",
"phoneNumberVerified": true,
"email": "example@example.com",
"emailVerified": true,
"userExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"userSourceType": "build_in",
"userSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"status": "enabled",
"accountExpireTime": 1652085686179,
"registerTime": 1652085686179,
"lockExpireTime": 1652085686179,
"createTime": 1652085686179,
"updateTime": 1652085686179,
"description": "测试账户"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。