Summary
Get all assignable roles.
Description
Get all assignable roles based on permissions in IAP.
Route
GET /user-management/roles
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
Options for query parameters. |
Copied to Clipboard
{
"queryOptions": {
"contains": "Admin",
"containsField": "name",
"equals": "Admin",
"equalsField": "name",
"startsWith": "Admin",
"startsWithField": "name",
"skip": 1,
"limit": 50,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"Admin"
]
},
"containsField": {
"type": "string",
"examples": [
"name"
]
},
"equals": {
"type": "string",
"examples": [
"Admin"
]
},
"equalsField": {
"type": "string",
"examples": [
"name"
]
},
"startsWith": {
"type": "string",
"examples": [
"Admin"
]
},
"startsWithField": {
"type": "string",
"examples": [
"name"
]
},
"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 |
Contains an array of roles, the applied skip/limit, and the total in the response. |
Copied to Clipboard
{
"results": [
{
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"description": "An example of a description."
},
{
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"description": "An example of a description."
},
{
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"description": "An example of a description."
},
{
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"description": "An example of a description."
},
{
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"description": "An example of a description."
}
],
"skip": 50,
"limit": 50,
"total": 5
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"provenance": {
"type": "string",
"examples": [
"Local AAA"
]
},
"name": {
"type": "string",
"examples": [
"Admin"
]
},
"description": {
"type": "string",
"examples": [
"An example of a description."
]
}
}
}
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"total": {
"$ref": "common-schema#/definitions/total"
}
}
}
