Summary
Get all groups from Local AAA instance.
Description
Get all groups from Local AAA instance in IAP.
Route
GET /user-management/groups
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| queryOptions | object | yes | Options for query parameters. |
{ "queryOptions": { "contains": "Admin", "containsField": "name", "equals": "Admin", "equalsField": "name", "startsWith": "Admin", "startsWithField": "name", "skip": 10, "limit": 50, "sort": "name", "order": 1 } }
{ "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
| Name | Type | Description |
|---|---|---|
| result | object | Contains an array of groups, the applied skip/limit, and the total in the response. |
{ "results": [ { "_id": "5dd2cdab94410956f3ecbc79", "provenance": "Local AAA", "name": "Admin", "memberOf": [ { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true }, { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true }, { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true }, { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "1004" }, { "roleId": "1004" }, { "roleId": "1004" }, { "roleId": "1004" }, { "roleId": "1004" } ], "lastLogin": "2020-10-26T15:17:17.582Z", "inactive": false, "_meta": { "created": "2020-10-26T15:17:17.582Z", "updated": "2020-10-26T15:17:17.582Z" } }, { "_id": "5dd2cdab94410956f3ecbc79", "provenance": "Local AAA", "name": "Admin", "memberOf": [ { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "1004" }, { "roleId": "1004" }, { "roleId": "1004" } ], "lastLogin": "2020-10-26T15:17:17.582Z", "inactive": false, "_meta": { "created": "2020-10-26T15:17:17.582Z", "updated": "2020-10-26T15:17:17.582Z" } }, { "_id": "5dd2cdab94410956f3ecbc79", "provenance": "Local AAA", "name": "Admin", "memberOf": [ { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true }, { "groupId": "5dd2cdab94410956f3ecbc79", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "1004" }, { "roleId": "1004" }, { "roleId": "1004" } ], "lastLogin": "2020-10-26T15:17:17.582Z", "inactive": false, "_meta": { "created": "2020-10-26T15:17:17.582Z", "updated": "2020-10-26T15:17:17.582Z" } } ], "skip": 0, "limit": 50, "total": 10 }
{ "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" ] }, "memberOf": { "type": "array", "items": { "type": "object", "properties": { "groupId": { "type": "string", "examples": [ "5dd2cdab94410956f3ecbc79" ] }, "aaaManaged": { "type": "boolean", "enum": [ true ] } } } }, "assignedRoles": { "type": "array", "items": { "type": "object", "properties": { "roleId": { "type": "string", "examples": [ "1004" ] } } } }, "lastLogin": { "type": "string", "examples": [ "2020-10-26T15:17:17.582Z" ] }, "inactive": { "type": "boolean", "enum": [ true, false ] }, "_meta": { "type": "object", "properties": { "created": { "type": "string", "examples": [ "2020-10-26T15:17:17.582Z" ] }, "updated": { "type": "string", "examples": [ "2020-10-26T15:17:17.582Z" ] } } } } } }, "skip": { "$ref": "common-schema#/definitions/skip" }, "limit": { "$ref": "common-schema#/definitions/limit" }, "total": { "$ref": "common-schema#/definitions/total" } } }