分页查询EIAM账户信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| eiam:ListUsers | get | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
| PageNumber | long | 否 | 列表页码，默认 1。 | 1 |
| PageSize | long | 否 | 列表大小，默认 20，最大不超过 100。 | 20 |
| UserIds | array | 否 | 账户 ID 列表。 | |
| string | 否 | 账户 ID。 | user_d6sbsuumeta4h66ec3il7yxxxx | |
| UsernameStartsWith | string | 否 | 账户名前缀，采用左匹配查询。 | name_001 |
| DisplayNameStartsWith | string | 否 | 账户展示名前缀，采用左匹配查询。 | name |
| PhoneRegion | string | 否 | 手机地区编号,示例：中国大陆手区号为 86，不带 00 或 +。 | 86 |
| PhoneNumber | string | 否 | 账户手机号。 | 156xxxxxxx |
| string | 否 | 账户邮箱。 | user@example.com | |
| UserExternalId | string | 否 | 外部 ID，用于外部数据与 IDaaS 账户的数据关联映射。 说明：外部 ID 在同一来源类型和来源 ID 下唯一。 | id_wovwffm62xifdziem7an7xxxxx |
| UserSourceId | string | 否 | 账户来源 ID。 自建类型默认为实例 ID，其他类型，分别对应不同来源的企业 ID，比如钉钉来源对应钉钉企业的 corpId。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
| UserSourceType | string | 否 | 账户来源类型，取值可选范围：
| build_in |
| Status | string | 否 | 账户状态，取值可选范围：
| enable |
| OrganizationalUnitId | string | 否 | 组织 ID。 | ou_wovwffm62xifdziem7an7xxxxx |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"TotalCount": 100,
"Users": [
{
"UserId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"Username": "name001",
"DisplayName": "display_name001",
"PasswordSet": false,
"PhoneRegion": "86",
"PhoneNumber": "156xxxxxxx",
"PhoneNumberVerified": true,
"Email": "user@example.com",
"EmailVerified": true,
"UserExternalId": "user_d6sbsuumeta4h66ec3il7yxxxx",
"UserSourceType": "build_in",
"UserSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"Status": "enabled",
"AccountExpireTime": 1652085686179,
"PasswordExpireTime": 1652085686179,
"RegisterTime": 1652085686179,
"LockExpireTime": 1652085686179,
"CreateTime": 1652085686179,
"UpdateTime": 1652085686179,
"Description": "测试账户",
"InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
}
]
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-06-21 | OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-03-21 | OpenAPI 描述信息更新、OpenAPI 返回结构发生变更 | 查看变更详情 |