文档首页/ IAM 身份中心/ API参考/ API/ 用户管理/ 列出用户
更新时间：2024-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

列出用户

功能介绍

查询指定身份源下的IAM身份中心用户列表。

URI

GET /v1/identity-stores/{identity_store_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

是

String

身份源的全局唯一标识符（ID）。

最小长度：12

最大长度：12
表2 Query参数

参数

是否必选

参数类型

描述

marker

否

String

分页标记。

最小长度：24

最大长度：24

limit

否

Integer

每个请求返回的最大结果数。

最小值：1

最大值：100

缺省值：100

user_name

否

String

用户名。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

最大长度：2048

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

page_info

Object

包含分页信息的对象。

users

Array of objects

身份源中的用户列表。
表5 page_info

参数

参数类型

描述

next_marker

String

如果存在，则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中，在标签请求参数中使用此值，以获取输出的下一部分。您应该重复此操作，直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量。
表6 users

参数

参数类型

描述

addresses

Array of objects

用户的地址信息列表。

数组长度：1-1

display_name

String

用户的显示名称。

最小长度：1

最大长度：1024

emails

Array of objects

用户的电子邮箱信息列表。

数组长度：1-1

external_id

String

外部身份源分配给此资源的标识符。

external_ids

Array of objects

用户的外部标识符信息列表。

数组长度：1-10

identity_store_id

String

身份源的全局唯一标识符（ID）。

最小长度：1

最大长度：36

locale

String

用户的地理区域或位置信息。

最小长度：1

最大长度：1024

name

Object

包含用户姓名信息的对象。

nickname

String

用户昵称。

最小长度：1

最大长度：1024

phone_numbers

Array of objects

用户的电话号码信息列表。

数组长度：1-1

preferred_language

String

用户语言首选项。

最小长度：1

最大长度：1024

profile_url

String

与用户关联的URL。

最小长度：1

最大长度：1024

timezone

String

用户时区。

最小长度：1

最大长度：1024

title

String

用户头衔。

最小长度：1

最大长度：1024

user_id

String

身份源中IAM身份中心用户的全局唯一标识符（ID）。

最小长度：1

最大长度：47

user_name

String

用户名，用于标识用户的唯一字符串。

最小长度：2

最大长度：128

user_type

String

用户类型。

最小长度：1

最大长度：1024

created_at

Long

创建用户时的时间戳。

created_by

String

创建者。

updated_at

Long

更新用户时的时间戳。

updated_by

String

更新者。

enabled

Boolean

一个布尔值，表示用户是否启用。

enterprise

Object

包含用户工作相关信息的对象。
表7 users.addresses

参数

参数类型

描述

country

String

国家/地区。

最小长度：1

最大长度：1024

formatted

String

包含要显示的地址的格式化版本的字符串。

最小长度：1

最大长度：1024

locality

String

地址位置。

最小长度：1

最大长度：1024

postal_code

String

邮政编码。

最小长度：1

最大长度：1024

primary

Boolean

一个布尔值，表示这是否为用户的主地址。

region

String

区域。

最小长度：1

最大长度：1024

street_address

String

街道。

最小长度：1

最大长度：1024

type

String

表示地址类型的字符串。

最小长度：1

最大长度：1024
表8 users.emails

参数

参数类型

描述

primary

Boolean

一个布尔值，表示这是否为用户的主电子邮箱。

type

String

表示电子邮箱类型的字符串。

最小长度：1

最大长度：1024

value

String

包含电子邮箱地址的字符串。

最小长度：1

最大长度：1024

verification_status

String

String

电子邮箱地址的验证状态。

枚举值：

  • NOT_VERIFIED
  • VERIFIED
表9 users.external_ids

参数

参数类型

描述

id

String

外部身份提供商颁发给此资源的标识符。

最小长度：1

最大长度：256

issuer

String

外部标识符的颁发者。

最小长度：1

最大长度：100
表10 users.name

参数

参数类型

描述

family_name

String

用户的姓氏。

最小长度：1

最大长度：1024

formatted

String

包含要显示的名称的格式化版本的字符串。

最小长度：1

最大长度：1024

given_name

String

用户的名字。

最小长度：1

最大长度：1024

honorific_prefix

String

用户的尊称前缀。

最小长度：1

最大长度：1024

honorific_suffix

String

用户的尊称后缀。

最小长度：1

最大长度：1024

middle_name

String

用户的中间名。

最小长度：1

最大长度：1024
表11 users.phone_numbers

参数

参数类型

描述

primary

Boolean

一个布尔值，表示这是否为用户的主电话号码。

type

String

表示电话号码类型的字符串。

最小长度：1

最大长度：1024

value

String

包含电话号码的字符串。

最小长度：1

最大长度：1024
表12 enterprise

参数

参数类型

描述

cost_center

String

成本中心。

最小长度：1

最大长度：1024

department

String

部门。

最小长度：1

最大长度：1024

division

String

分部。

最小长度：1

最大长度：1024

employee_number

String

员工编号。

最小长度：1

最大长度：1024

manager

Object

经理。

organization

String

组织。

最小长度：1

最大长度：1024
表13 manager

参数

参数类型

描述

value

String

经理。

最小长度：1

最大长度：1024

状态码： 400

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

状态码： 403

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

请求示例

查询指定身份源下的IAM身份中心用户列表。

GET https://{hostname}/v1/identity-stores/{identity_store_id}/users

响应示例

状态码： 200

{
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  },
  "users" : [ {
    "addresses" : null,
    "display_name" : "用户显示名",
    "emails" : [ {
      "primary" : true,
      "type" : "Work",
      "value" : "email@example.com"
    } ],
    "external_ids" : null,
    "identity_store_id" : "d-a00aaaa33f",
    "locale" : null,
    "name" : {
      "family_name" : "姓氏",
      "formatted" : null,
      "given_name" : "名字",
      "honorific_prefix" : null,
      "honorific_suffix" : null,
      "middle_name" : null
    },
    "nickname" : null,
    "phone_numbers" : null,
    "preferred_language" : null,
    "profile_url" : null,
    "timezone" : null,
    "title" : null,
    "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
    "user_name" : "用户名u1",
    "user_type" : null,
    "created_at" : 1687184129925,
    "created_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "updated_at" : 1687184129926,
    "updated_by" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "enabled" : true
  } ]
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 用户管理

相关文档