v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-03-211931021.7 MB

Security Roles

List all Security Roles

Filtering

This endpoint supports result filtering. For more information on how to filter this request, go here.

OAuth Scope

This endpoint requires the following OAuth scope read_security_roles.

get/securityrole.json

Response

An array of Security Roles

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"
  }
]