查询OU下用户信息
功能介绍
查询OU下用户信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v2/{project_id}/ou-users
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
ou_dn |
是 |
String |
OU的域名地址。 |
|
user_name |
否 |
String |
用户名，支持模糊查询。 |
|
has_existed |
否 |
Boolean |
用户是否已存在。 |
|
limit |
否 |
Integer |
用于分页查询，返回桌面数量限制。如果不指定，则返回所有符合条件的桌面。 |
|
offset |
否 |
Integer |
用于分页查询，查询的起始记录序号，从0开始。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型，如：application/json。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_infos |
Array of AdOuUserInfo objects |
OU对象。 |
|
total_count |
Integer |
用户数。 |
|
enable_create_count |
Integer |
可以创建的用户数量。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
user_name |
String |
名称。 |
|
expired_time |
String |
过期时间 -1代表永不过期。 |
|
has_existed |
Boolean |
是否存在于用户列表。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：405
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
状态码：503
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
|
encoded_authorization_message |
String |
加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。 |
请求示例
无
响应示例
状态码：200
查询OU信息。
{
"user_infos" : [ {
"user_name" : "wksmanager",
"expired_time" : "2022-12-17 00:00:00",
"has_existed" : false
}, {
"user_name" : "wksmanager",
"expired_time" : "-1",
"has_existed" : false
} ],
"total_count" : 2
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询OU信息。 |
|
400 |
由于包含语法错误，当前请求无法被服务器理解。 |
|
401 |
鉴权失败。 |
|
403 |
没有操作权限。 |
|
404 |
找不到资源。 |
|
405 |
请求中指定的方法不被允许。 |
|
500 |
服务内部错误，具体返回错误码请参见错误码说明。 |
|
503 |
服务不可用。 |
错误码
请参见错误码。
