Querying the Application Role List

Function

This API is used to query the application role list.

URI

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Page number.
limit	Yes	Integer	Number of data records on each page.

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.
roles	Array of RoleInfoResult objects	Role information set.

**Table 5** RoleInfoResult
Parameter	Type	Description
id	String	Role ID.
code	String	Role code.
name	String	Role name.
createdAt	String	Creation time.
updatedAt	String	Modification time.

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 list by application ID in the pagination mode. The first 10 records are returned. If the number of records is less than 10, all results are returned.

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

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

Example Responses

Status code: 200

Request successful.

{
  "total" : 3,
  "offset" : 0,
  "limit" : 10,
  "roles" : [ {
    "id" : "20220415170305200-EF22-C2404E358",
    "code" : "role1",
    "name" : "role1",
    "createdAt" : "2022-04-15 17:03:05.200",
    "updatedAt" : null
  }, {
    "id" : "20220415170305223-7193-A01122B37",
    "code" : "role2",
    "name" : "role2",
    "createdAt" : "2022-04-15 17:03:05.223",
    "updatedAt" : null
  }, {
    "id" : "20220420144449385-C66D-E8C1D1D79",
    "code" : "admin",
    "name" : "Administrator",
    "createdAt" : "2022-04-20 14:44:49.385",
    "updatedAt" : null
  } ]
}