Updated on 2024-12-30 GMT+08:00

Querying Application Role Details

Function

This API is used to query application role details.

URI

GET /api/v2/tenant/applications/{application_id}/role/{role_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

application_id

Yes

String

Application ID.

role_id

Yes

String

Role ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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 3 Response body parameters

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 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error details.

Example Requests

Query application role details based on the application ID and role ID.

GET  https://{domain_name}/api/v2/tenant/applications/{application_id}/role/{role_id}

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

Example Responses

Status code: 200

Request successful.

{
  "id" : "20220210090626329-AFAE-EB2862B3A",
  "code" : "admin",
  "name" : "Administrator",
  "createdAt" : "2022-02-10 09:06:26.333",
  "updatedAt" : "2022-02-10 09:06:26.333"
}

Status Codes

Status Code

Description

200

Request successful.

400

Request failed.

Error Codes

See Error Codes.