Summary
Get a simplified list of groups.
Description
Get a simplified list of groups
Route
GET /authorization/groups/list
Roles
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| queryOptions |
object |
yes |
The query options for searching groups. |
Copied to Clipboard
{
"queryOptions": {
"multiContains": {
"name": "group1",
"provenance": "Local AAA",
"description": "this is group1"
},
"multiEquals": {
"name": "group1",
"provenance": "Local AAA",
"description": "this is group1"
},
"multiStartsWith": {
"name": "group1",
"provenance": "Local AAA",
"description": "this is group1"
},
"inactive": true,
"skip": 0,
"limit": 1,
"sort": "name",
"order": 1,
"refresh": false
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"$ref": "authorization-common#/definitions/groups-query"
},
"multiEquals": {
"$ref": "authorization-common#/definitions/groups-query"
},
"multiStartsWith": {
"$ref": "authorization-common#/definitions/groups-query"
},
"inactive": {
"$ref": "groups-schema#/properties/inactive"
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
},
"refresh": {
"type": "boolean",
"title": "refresh",
"description": "whether to refresh groups from AAA",
"default": false
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The groups matching the specified query. |
Copied to Clipboard
{
"results": {
"_id": "5cb7b531d06cceb89fd21b1c",
"provenance": "Pronghorn",
"name": "group_1"
},
"total": 1
}
