Querying the Application Role Member List

Function

This API is used to query the application role member list.

URI

GET /api/v2/tenant/applications/{application_id}/role-member-list/{role_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID.
role_id	Yes	String	Role ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	Yes	Integer	Page number. Min. value: 0.
limit	Yes	Integer	Number of data records on each page. Min. value: 10. Max. value: 100.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Set this field to "application/json;charset=utf8".
Authorization	Yes	String	Authentication credential. The value is "Bearer {access_token}". access_token is obtained by calling the API for obtaining an access credential.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total	Integer	Total number.
offset	Integer	Page number.
limit	Integer	Number of data records on each page.
role_members	Array of RoleMemberInfo objects	Role member information set.

**Table 5** RoleMemberInfo
Parameter	Type	Description
id	String	Application account ID.
account_name	String	Application account name.
name	String	Real name.
org_id	String	Application organization ID.
disabled	Boolean	Whether disabled.
account_type	String	Application account type.
extension	Object	Custom extended attribute.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error details.

Example Requests

Query the application role member list by application ID and role ID in the pagination mode. The first 10 data records are returned. If the number of data records is less than 10, all results are returned.

GET https://{domain_name}/api/v2/tenant/applications/{application_id}/role-member-list/{role_id}?offset=0&limit=10

Authorization: Bearer 334963fc-1e4a-473b-9096-52a929140...

Example Responses

Status code: 200

Request successful.

{
  "total" : 1,
  "offset" : 0,
  "limit" : 10,
  "role_members" : [ {
    "id" : "20220210090626329-AFAE-EB2862B3A",
    "account_name" : "adminAcc",
    "account_type" : "1",
    "name" : "Administrator",
    "org_id" : "20220210135202250-92C8-D89EC88C6",
    "disabled" : false,
    "extension" : null
  } ]
}