Amazon Cognito · JSON Structure

User Pools List Users In Group Request Structure

ListUsersInGroupRequest schema from Amazon Cognito API

Type: object Properties: 4 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

ListUsersInGroupRequest is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId GroupName Limit 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-cognito/refs/heads/main/json-structure/user-pools-list-users-in-group-request-structure.json",
  "name": "ListUsersInGroupRequest",
  "description": "ListUsersInGroupRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool."
        }
      ]
    },
    "GroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupNameType"
        },
        {
          "description": "The name of the group."
        }
      ]
    },
    "Limit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueryLimitType"
        },
        {
          "description": "The limit of the request to list users."
        }
      ]
    },
    "NextToken": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PaginationKey"
        },
        {
          "description": "An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "GroupName"
  ]
}