privilege.roles¶
Get all available roles.
Type: object
No Additional Properties
No Additional Items
Type: array
No Additional Items
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []No Additional Items
Each item of this array must be:
Type: object
Parameter 2: options
options
Type: objectDefault:
{
"relationships": true,
"extend": null,
"extend_context": null,
"prefix": null,
"extra": {},
"order_by": [],
"select": [],
"count": false,
"get": false,
"offset": 0,
"limit": 0,
"force_sql_filters": false
}
No Additional Properties
Relationships
Type: boolean Default: trueExtend
Default: null
Type: string
Type: null
Extend Context
Default: null
Type: string
Type: null
Prefix
Default: null
Type: string
Type: null
Extra
Type: object Default: {}Order By
Type: array of string Default: []No Additional Items
Each item of this array must be:
Type: string
Select
Type: array Default: []No Additional Items
Each item of this array must be:
Type: string
Type: array
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Value must be greater or equal to 0
Limit
Type: integer Default: 0Value must be greater or equal to 0 and lesser or equal to 10000
Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
Each item of this array must be:
PrivilegeRolesEntry
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1 characters long
Title
Type: stringMust be at least 1 characters long
Includes
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1 characters long
Builtin
Type: booleanSTIGType
Type: enum (of integer)Currently we are only attempting to meet a single STIG (General Purpose
Operating System). This enum is defined so that we have capability
to expand if we decide to apply more specific STIGs to different areas
of our product
Must be one of:
- 0
- 1
Type: null
PrivilegeRolesEntry
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1 characters long
Title
Type: stringMust be at least 1 characters long
Includes
Type: array of stringNo Additional Items
Each item of this array must be:
Type: string
Must be at least 1 characters long
Builtin
Type: boolean
Type: object
Type: null
Type: array of object
No Additional Items
No Additional Items
Each item of this array must be:
Type: object
Type: object
Type: integer
Required roles: