查询候选用户成员 - CheckCanAuthUsersOfApp
功能介绍
查询应用的候选用户成员列表,会过滤掉异常状态用户。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
GET /v2/{project_id}/instances/{instance_id}/apps/{app_id}/candidates
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
是 |
String |
应用ID。 |
|
instance_id |
是 |
String |
实例ID。 |
|
project_id |
是 |
String |
项目ID,获取方式请参见API参考的“附录 > 获取项目ID”章节。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
filter |
否 |
String |
过滤条件。
|
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
users |
Array of CandidatesUser objects |
候选用户成员列表。 |
状态码:403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误消息。 |
|
error_details |
String |
具体错误消息。 |
|
request_id |
String |
请求处理ID。 |
请求示例
无
响应示例
状态码:200
OK
{
"users" : [ {
"name" : "chenjunjie",
"id" : "06d9106f3b000f241f83c010d6b78c81"
}, {
"name" : "fdi-dm",
"id" : "076d742f028025191fe9c0109200f5c8"
} ]
}
状态码:403
Forbidden
{
"error_code" : "ROMA.00000101",
"error_msg" : "error summary",
"error_details" : "some error details here",
"request_id" : "13760c1fe8655e61209b75665e9bef43"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
403 |
Forbidden |
错误码
请参见错误码。