Retrieve a role with its permissions

{
  "id": 1,
  "name": "Administrator",
  "name_translation_key": "user_role_administrator_name",
  "description": "Full access to all organization features and settings.",
  "description_translation_key": "user_role_administrator_description",
  "user_count": 4,
  "type": "system",
  "is_system_role": true,
  "permissions": [
    {
      "id": 1,
      "resource": "ApiCallback",
      "action": "List"
    },
    {
      "id": 2,
      "resource": "Endpoint",
      "action": "List"
    },
    {
      "id": 3,
      "resource": "Endpoint",
      "action": "Create"
    },
    {
      "id": 4,
      "resource": "Endpoint",
      "action": "Delete"
    },
    {
      "id": 5,
      "resource": "ServicePolicy",
      "action": "List"
    }
  ]
}

Organisation.Role + Get

Roles: Administrator User

Returns a single role with its full permission list. Works for both system and custom roles.

Use my in place of a numeric orgId to target the caller’s own Workspace.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Path parameters

roleIdintegerRequired>=1

Numeric identifier of the role.

orgIdinteger or enumRequired

Workspace identifier. Either a positive integer organization ID, or the literal string my to target the caller’s own Workspace.

Response

Successful response.

iddouble

Unique role identifier.

namestring

Display name of the role.

name_translation_keystring or null

Translation key for the role name. Set for system roles only.

descriptionstring

Human-readable description of the role. An empty string when no description has been set.

description_translation_keystring or null

Translation key for the role description. Set for system roles only.

user_countdouble

Number of users assigned to this role in the Workspace.

typeenum

Whether this is a system-defined role or an organization’s custom role.

Allowed values:

is_system_roleboolean

True for built-in system roles, which can’t be modified or deleted.

permissionslist of objectsOptional

Full list of permissions assigned to this role.

Errors

404

Not Found Error