列出组织中的账号
功能介绍
列出组织中的账号。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。如果指定父级组织单元，则将获得作为父级直系子级的所有账号的列表。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET https://{endpoint}/v1/organizations/accounts
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
parent_id |
否 |
String |
父节点（根或组织单元）的唯一标识符（ID）。 |
|
with_register_contact_info |
否 |
Boolean |
是否返回账号邮箱、手机号信息。若此参数为True，Limit最多200。 |
|
limit |
否 |
Integer |
页面中最大结果数量。 |
|
marker |
否 |
String |
分页标记。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Security-Token |
否 |
String |
如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
accounts |
Array of AccountDto objects |
组织中的账号列表。 |
|
page_info |
PageInfoDto object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
账号的唯一标识符（ID）。 |
|
urn |
String |
账号的统一资源名称。 |
|
join_method |
String |
账号加入组织的方式。invited：邀请加入，created：创建加入。 |
|
status |
String |
账号当前的状态。active：有效； suspended：已关闭； pending_closure：关闭中。 |
|
joined_at |
String |
账号加入组织的日期。 |
|
name |
String |
账号名称 |
|
mobile_phone |
String |
手机号码 |
|
intl_number_prefix |
String |
手机号前缀。 |
|
|
String |
与此账号关联的电子邮件地址。 |
|
description |
String |
描述信息。 |
请求示例
列出组织中的账号
GET https://{endpoint}/v1/organizations/accounts
响应示例
状态码： 200
Successful.
{
"accounts" : [ {
"id" : "05261f923e80d3890f33c0056e9b3f80",
"urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
"join_method" : "invited",
"joined_at" : "2022-08-24T06:41:15Z",
"name" : "paas_iam_573331",
"status" : "active",
"mobile_phone" : "null,",
"intl_number_prefix" : "null,",
"email" : null
} ],
"page_info" : {
"next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
"current_count" : 100
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Successful. |
错误码
请参见错误码。
