Security Roles

Route Capability Description
List roles
GET /settings/security-roles
security.roles-list List all roles without pagination.
Get role
GET /settings/security-roles/:role_id
security.roles-detail Get details of a role.
Create role
POST /settings/security-roles
security.roles-create Create a role.
Update role
POST /settings/security-roles/:role_id
security.roles-update Update a role.

List roles

GET roles 

List all roles without pagination.

Parameters

Parameter Type Information
name string Search roles by roles name.
Variantsname_startswith and name_contains
description string
Search roles by description.
Variantsdescription_startswith and description_contains
filter_by string Filter roles by status.
Allowed Valuesallactiveinactive
sort_column string

Sort roles. Standard on title
Allowed Valuesname,description

sort_order string

Sort order. Standard on ASC
Allowed Values: ASC,DESC

Get Role

GET /settings/security-roles/:role_id 

Get details of a role.