Amazon Cognito · JSON Structure

User Pools Admin Add User To Group Request Structure

AdminAddUserToGroupRequest schema from Amazon Cognito API

Type: object Properties: 3 Required: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

UserPoolId Username GroupName

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-admin-add-user-to-group-request-structure.json",
  "name": "AdminAddUserToGroupRequest",
  "description": "AdminAddUserToGroupRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool."
        }
      ]
    },
    "Username": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UsernameType"
        },
        {
          "description": "The username for the user."
        }
      ]
    },
    "GroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GroupNameType"
        },
        {
          "description": "The group name."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Username",
    "GroupName"
  ]
}