Sign in
Security Roles

Retrieve a Security Role

OAuth Scope

This endpoint requires the following OAuth scope read_security_roles.

get/securityrole/{uuid}.json

Path parameters

uuidstring uuid required

UUID of the Security Role

Response

Security Role record retrieved successfully

namestring required

The name given to the security role

role_descriptionstring

A detailed description of the security role's purpose and permissions. This field provides information about what access and capabilities are granted to users assigned this role.

uuidstring uuid

Unique identifier for this record

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "uuid": "123e4567-971c-409a-af66-23f944f46cab",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

Changed in 2 of the 50 revisions of this API.6

  • ca9b053c43735See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • e859f8c27a211See the full diff
    • ○

      the security scope read_security_roles was added to the endpoint's security scheme oauth2

      api-security-scope-added