Summary
          Get all groups from Local AAA instance.
          Description
          Get all groups from Local AAA instance in IAP.
          Route
          GET /user-management/groups
          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": 50,
    "limit": 25,
    "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 groups, the applied skip/limit, and the total in the response. | 
            
          
          
            Copied to Clipboard
            
            {
  "results": [
    {
      "_id": "5dd2cdab94410956f3ecbc79",
      "provenance": "Local AAA",
      "name": "Admin",
      "memberOf": [
        {
          "groupId": "5dd2cdab94410956f3ecbc79",
          "aaaManaged": true
        },
        {
          "groupId": "5dd2cdab94410956f3ecbc79",
          "aaaManaged": true
        }
      ],
      "assignedRoles": [
        {
          "roleId": "1004"
        },
        {
          "roleId": "1004"
        },
        {
          "roleId": "1004"
        },
        {
          "roleId": "1004"
        }
      ],
      "lastLogin": "2020-10-26T15:17:17.582Z",
      "inactive": true,
      "_meta": {
        "created": "2020-10-26T15:17:17.582Z",
        "updated": "2020-10-26T15:17:17.582Z",
        "migrationVersion": 1
      }
    },
    {
      "_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"
        }
      ],
      "lastLogin": "2020-10-26T15:17:17.582Z",
      "inactive": false,
      "_meta": {
        "created": "2020-10-26T15:17:17.582Z",
        "updated": "2020-10-26T15:17:17.582Z",
        "migrationVersion": 1
      }
    }
  ],
  "skip": 1,
  "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"
            ]
          },
          "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"
                ]
              },
              "migrationVersion": {
                "type": "integer",
                "examples": [
                  1
                ]
              }
            }
          }
        }
      }
    },
    "skip": {
      "$ref": "common-schema#/definitions/skip"
    },
    "limit": {
      "$ref": "common-schema#/definitions/limit"
    },
    "total": {
      "$ref": "common-schema#/definitions/total"
    }
  }
}