Skip to main content
POST
Get role detail

Restrictions

Usage

  • IDs 2, 6, and 8 return the built-in Admin, Responder, and Viewer roles; their description follows the request language.
  • A role ID that does not exist or was deleted returns 400 InvalidParameter.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
role_id
integer<uint64>
required

Role ID to query. Get IDs from POST /role/list (built-in roles: 2=Admin, 6=Responder, 8=Viewer).

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

A role and its permission set.