cognitoidentityprovider_admin_add_user_to_group: Adds a user to a group

In paws.security.identity: 'Amazon Web Services' Security, Identity, & Compliance Services

Adds a user to a group

Description

Adds a user to a group. A user who is in a group can present a preferred-role claim to an identity pool, and populates a cognito:groups claim to their access and identity tokens.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_admin_add_user_to_group/ for full documentation.

Usage

cognitoidentityprovider_admin_add_user_to_group(
  UserPoolId,
  Username,
  GroupName
)

Arguments

UserPoolId	[required] The ID of the user pool that contains the group that you want to add the user to.
Username	[required] The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
GroupName	[required] The name of the group that you want to add your user to.

paws.security.identity documentation built on April 3, 2025, 10:59 p.m.