Amazon IAM Identity Center · JSON Structure

Identitystore List Groups Response Structure

ListGroupsResponse schema from AWS IAM Identity Center

Type: object Properties: 2 Required: 1
Access ControlAuthenticationIdentity ManagementSingle Sign-On

ListGroupsResponse is a JSON Structure definition published by Amazon IAM Identity Center, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Groups NextToken

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iam-identity-center/refs/heads/main/json-structure/identitystore-list-groups-response-structure.json",
  "name": "ListGroupsResponse",
  "description": "ListGroupsResponse schema from AWS IAM Identity Center",
  "type": "object",
  "properties": {
    "Groups": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Groups"
        },
        {
          "description": "A list of <code>Group</code> objects in the identity store."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NextToken"
        },
        {
          "description": "The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page."
        }
      ]
    }
  },
  "required": [
    "Groups"
  ]
}