Skip to main content
POST
List permissions

Restrictions

Usage

  • With with_all: true, every permission is returned and is_granted marks the ones granted by any role in role_ids.
  • With with_all false (the default), only the permissions granted by role_ids are returned — a call without role_ids returns an empty list.
  • permission_name, description, and class follow the request language (Accept-Language header, or the locale/lang query parameter).

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

Filters for listing permissions.

role_ids
integer<uint64>[]

Role IDs (built-in or custom) whose granted permissions to return or mark. IDs that do not exist are ignored.

with_all
boolean

When true, return every permission and use is_granted to mark the ones granted by role_ids. When false (default), return only the granted permissions.

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

Permission list result.