Summary
Get a list of roles.
Description
Get a list of roles
Route
GET /authorization/roles
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
The query options for searching roles. |
Copied to Clipboard
{
"queryOptions": {
"multiContains": {
"provenance": "Custom",
"name": "role_1",
"description": "description of role_1"
},
"multiEquals": {
"provenance": "Custom",
"name": "role_1",
"description": "description of role_1"
},
"multiStartsWith": {
"provenance": "Custom",
"name": "role_1",
"description": "description of role_1"
},
"inactive": true,
"skip": 0,
"limit": 1,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"$ref": "authorization-common#/definitions/roles-query"
},
"multiEquals": {
"$ref": "authorization-common#/definitions/roles-query"
},
"multiStartsWith": {
"$ref": "authorization-common#/definitions/roles-query"
},
"inactive": {
"type": "boolean"
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The roles matching the specified query. |
Copied to Clipboard
{
"results": {
"provenance": "Custom",
"name": "role_1",
"description": "description of role_1",
"allowedMethods": [
{
"name": "methodName",
"provenance": "ApplicationName"
}
],
"allowedViews": [
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
},
{
"path": "/manual/task/path",
"provenance": "ApplicationName"
}
],
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"updated": "2018-08-02T15:56:12.912Z"
}
},
"total": 1
}
