文档

ListUsers - 列表查询EIAM账户

更新时间:

调用ListUsers接口,分页查询EIAM账户信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

GET /v2/{instanceId}/{applicationId}/users

请求参数

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

认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。

Bearer AT8csE2seYxxxxxij
instanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
applicationIdstring

应用 ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx
organizationalUnitIdstring

组织 ID。

ou_wovwffm62xifdziem7an7xxxxx
pageNumberinteger

页码,默认 1。

1
pageSizeinteger

单页大小读取记录数,默认 20,范围为 1~100。

20

返回参数

名称类型描述示例值
object

响应结果。

totalCountlong

数据总记录数。

1000
dataarray<object>

返回数据对象列表。

object

返回数据对象。

instanceIdstring

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx
userIdstring

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx
usernamestring

账户名。

name001
displayNamestring

账户显示名。

display_name001
passwordSetboolean

密码是否已设置

true
phoneRegionstring

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

86
phoneNumberstring

账户手机号。

156xxxxxxx
phoneNumberVerifiedboolean

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

true
emailstring

账户邮箱。

example@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
registerTimelong

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

1652085686179
lockExpireTimelong

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

1652085686179
createTimelong

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

1652085686179
updateTimelong

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

1652085686179
descriptionstring

账户描述。

测试账户

示例

正常返回示例

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": "测试账户"
    }
  ]
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-10-24API 内部配置变更,不影响调用查看变更详情

错误码

HttpCodeError Code错误信息说明
400invalid_tokenAccess token is not validtoken 无效
404application_not_foundApplication id not found: app_001应用不存在
403application_disabledApplication is disabled应用处于禁用状态
403application_api_disabledApplication api invoke disabled应用 API 未开放
403permission_deniedRequire scopes: [urn:alibaba:idaas:scope:user:read_all]缺少 API 授权信息
500Internal Server ErrorInternal Server Error服务器内部错误