Querying Application Members

Function

This API is used to query the user member list.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v2/{project_id}/instances/{instance_id}/apps/{app_id}/users

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
app_id	Yes	String	Application ID.
instance_id	Yes	String	Instance ID.
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see "Appendix" > "Obtaining a Project ID" in the API Reference.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
user_name	No	String	Name of the member to query. Exact match is used.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number of members of an application.
id	String	Application ID.
users	Array of users objects	Members.

**Table 5** users
Parameter	Type	Description
id	String	User ID.
name	String	Username.
roles	Array of strings	Application permissions. read: permission to read resources of an application, including API debugging. This permission must be included. access: permission to access resources of an application. delete: permission to delete resources of an application. modify: permission to modify resources of an application, including API release and removal. admin: all permissions on an application and its resources. When only the user admin is provided, all other permissions are automatically applied. The read permission is automatically applied when it is not provided.

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_details	String	Error information.
request_id	String	Request ID.

Example Requests

None

Example Responses

Status code: 200

Query succeeded.

{
  "total" : 1,
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "users" : [ {
    "id" : "string",
    "name" : "string",
    "roles" : [ "read, access, delete, modify, admin" ]
  } ]
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}