调用ListUsers查询EIAM账户列表信息_应用身份服务 (IDaaS)(IDaaS)-阿里云帮助中心

分页查询EIAM账户信息。

接口说明

当前接口仅查询组织的直属权限，即直接分配给组织的应用。调用该接口时，可以通过 ApplicationIds 参数对应用进行筛选。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eiam:ListUsers

list

*User

acs:eiam:{#regionId}:{#accountId}:instance/{#InstanceId}/user/*

无

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumber	integer	否	列表页码，默认 1。	1
PageSize	integer	否	列表大小，默认 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
Email	string	否	账户邮箱。	user@example.com
UserExternalId	string	否	外部 ID，用于外部数据与 IDaaS 账户的数据关联映射。说明：外部 ID 在同一来源类型和来源 ID 下唯一。	id_wovwffm62xifdziem7an7xxxxx
UserSourceId	string	否	账户来源 ID。自建类型默认为实例 ID，其他类型，分别对应不同来源的企业 ID，比如钉钉来源对应钉钉企业的 corpId。	idaas_ue2jvisn35ea5lmthk267xxxxx
UserSourceType	string	否	账户来源类型，取值可选范围： build_in：自建。 ding_talk：钉钉导入。 ad：AD 导入。 ldap：LDAP 导入 we_com：企业微信导入。	build_in
Status	string	否	账户状态，取值可选范围： enabled：启用中。 disabled：禁用中。	enable
OrganizationalUnitId	string	否	组织 ID。	ou_wovwffm62xifdziem7an7xxxxx

返回参数

名称	类型	描述	示例值
	object	响应结果。
RequestId	string	请求 ID。	0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCount	integer	列表条数目。	100
Users	array<object>	账户数据列表。
	object	账户数据。
UserId	string	账户 ID。	user_d6sbsuumeta4h66ec3il7yxxxx
Username	string	账户名。	name001
DisplayName	string	账户显示名。	display_name001
PasswordSet	boolean	密码是否已设置。	false
PhoneRegion	string	手机地区编号,示例：中国大陆手区号为 86，不带 00 或 +。	86
PhoneNumber	string	账户手机号码。	156xxxxxxx
PhoneNumberVerified	boolean	手机号是否已验证，true 表示手机号已经过用户验证或被管理员设置为已验证，false 表示未验证。	true
Email	string	账户邮箱。	user@example.com
EmailVerified	boolean	邮箱是否已验证，true 表示邮箱已经过用户的验证或被管理员设置为已验证，false 表示未验证。	true
UserExternalId	string	账户外部 ID，用于外部数据与 IDaaS 账户的数据关联映射，默认为 IDaaS 账户 ID。说明：外部 ID 在同一来源类型和来源 ID 下唯一。	user_d6sbsuumeta4h66ec3il7yxxxx
UserSourceType	string	账户来源类型，取值可选范围： build_in：自建。 ding_talk：钉钉导入。 ad：AD 导入。 ldap：LDAP 导入	build_in
UserSourceId	string	账户来源 ID。自建类型默认为实例 ID，其他类型，分别对应不同来源的企业 ID，比如钉钉来源对应钉钉企业的 corpId。	idaas_ue2jvisn35ea5lmthk267xxxxx
Status	string	账户状态，取值可选范围： enabled：启用中。 disabled：禁用中。	enabled
AccountExpireTime	integer	账户过期时间，Unix 时间戳格式，单位为毫秒。	1652085686179
PasswordExpireTime	integer	密码过期时间，Unix 时间戳格式，单位为毫秒。	1652085686179
RegisterTime	integer	账户注册时间，Unix 时间戳格式，单位为毫秒。	1652085686179
LockExpireTime	integer	账户锁定过期时间，Unix 时间戳格式，单位为毫秒。	1652085686179
CreateTime	integer	账户创建时间，Unix 时间戳格式，单位为毫秒。	1652085686179
UpdateTime	integer	账户最近一次更新时间，Unix 时间戳格式，单位为毫秒。	1652085686179
Description	string	账户描述。	xxxx
InstanceId	string	实例 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx

示例

正常返回示例

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": "xxxx",
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ]
}

错误码

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

变更历史

更多信息，参考变更详情。