Retrieve SystemRoles

GET {{baseUrl}}/api/v3/security/systemRoles?tql=&fields=<string>&fields=<string>&count=<string>&sorting=<string>

Returns a list of all SystemRoles

Request Params

KeyDatatypeRequiredDescription
tqlnullTQL query string for filtering response list
fieldsstringSystemRole subentity fields to include in response (See OPTIONS endpoint for valid values)
fieldsstringSystemRole subentity fields to include in response (See OPTIONS endpoint for valid values)
countstringBoolean that denotes whether counts should be returned in the resultset
sortingstringSorting order for resultset

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;assignable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;displayed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;},{&quot;active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;assignable&quot;:&quot;\u003cboolean\u003e&quot;,&quot;displayed&quot;:&quot;\u003cboolean\u003e&quot;,&quot;id&quot;:&quot;\u003clong\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;}]