文档

ListUsers - 列表查询EIAM账户信息

更新时间:

分页查询EIAM账户信息。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eiam:ListUsersRead
  • 全部资源
    acs:eiam:{#regionId}:{#accountId}:*

请求参数

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

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
PageNumberlong

列表页码,默认 1。

1
PageSizelong

列表大小,默认 20,最大不超过 100。

20
UserIdsarray

账户 ID 列表。

string

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx
UsernameStartsWithstring

账户名前缀,采用左匹配查询。

name_001
DisplayNameStartsWithstring

账户展示名前缀,采用左匹配查询。

name
PhoneRegionstring

手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +。

86
PhoneNumberstring

账户手机号。

156xxxxxxx
Emailstring

账户邮箱。

user@example.com
UserExternalIdstring

外部 ID,用于外部数据与 IDaaS 账户的数据关联映射。

说明:外部 ID 在同一来源类型和来源 ID 下唯一。

id_wovwffm62xifdziem7an7xxxxx
UserSourceIdstring

账户来源 ID。

自建类型默认为实例 ID,其他类型,分别对应不同来源的企业 ID,比如钉钉来源对应钉钉企业的 corpId。

idaas_ue2jvisn35ea5lmthk267xxxxx
UserSourceTypestring

账户来源类型,取值可选范围:

  • build_in:自建。
  • ding_talk:钉钉导入。
  • ad:AD 导入。
  • ldap:LDAP 导入
  • we_com:企业微信导入。
build_in
Statusstring

账户状态,取值可选范围:

  • enabled: 启用中。
  • disabled: 禁用中。
enable
OrganizationalUnitIdstring

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx

返回参数

名称类型描述示例值
object

响应结果。

RequestIdstring

请求 ID。

0441BD79-92F3-53AA-8657-F8CE4A2B912A
TotalCountlong

列表条数目。

100
Usersobject []

账户数据列表。

UserIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx
Usernamestring

账户名。

name001
DisplayNamestring

账户显示名。

display_name001
PasswordSetboolean

密码是否已设置

false
PhoneRegionstring

手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +。

86
PhoneNumberstring

账户手机号码。

156xxxxxxx
PhoneNumberVerifiedboolean

手机号是否已验证,true 表示手机号已经过用户验证或被管理员设置为已验证,false 表示未验证。

true
Emailstring

账户邮箱。

user@example.com
EmailVerifiedboolean

邮箱是否已验证,true 表示邮箱已经过用户的验证或被管理员设置为已验证,false 表示未验证。

true
UserExternalIdstring

账户外部 ID,用于外部数据与 IDaaS 账户的数据关联映射,默认为 IDaaS 账户 ID。

说明:外部 ID 在同一来源类型和来源 ID 下唯一。

user_d6sbsuumeta4h66ec3il7yxxxx
UserSourceTypestring

账户来源类型,取值可选范围:

  • build_in:自建。
  • ding_talk:钉钉导入。
  • ad:AD 导入。
  • ldap:LDAP 导入
build_in
UserSourceIdstring

账户来源 ID。

自建类型默认为实例 ID,其他类型,分别对应不同来源的企业 ID,比如钉钉来源对应钉钉企业的 corpId。

idaas_ue2jvisn35ea5lmthk267xxxxx
Statusstring

账户状态,取值可选范围:

  • enabled: 启用中。
  • disabled:禁用中。
enabled
AccountExpireTimelong

账户过期时间,Unix 时间戳格式,单位为毫秒。

1652085686179
PasswordExpireTimelong

密码过期时间,Unix 时间戳格式,单位为毫秒。

1652085686179
RegisterTimelong

账户注册时间,Unix 时间戳格式,单位为毫秒。

1652085686179
LockExpireTimelong

账户锁定过期时间,Unix 时间戳格式,单位为毫秒。

1652085686179
CreateTimelong

账户创建时间,Unix 时间戳格式,单位为毫秒。

1652085686179
UpdateTimelong

账户最近一次更新时间,Unix 时间戳格式,单位为毫秒。

1652085686179
Descriptionstring

账户描述。

测试账户
InstanceIdstring

实例 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": "测试账户",
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-06-21OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:UserIds
    新增入参:UsernameStartsWith
    新增入参:DisplayNameStartsWith
2023-03-21OpenAPI 描述信息更新、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
出参OpenAPI 返回结构发生变更
  • 本页导读 (0)
文档反馈