Given a username and a group name, removes them from the group — cognitoidentityprovider_admin_remove_user_from

Given a username and a group name, removes them from the group. User pool groups are identifiers that you can reference from the contents of ID and access tokens, and set preferred IAM roles for identity-pool authentication. For more information, see Adding groups to a user pool.

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

Usage

cognitoidentityprovider_admin_remove_user_from_group(
  UserPoolId,
  Username,
  GroupName
)

Arguments

UserPoolId: [required] The ID of the user pool that contains the group and the user that you want to remove.
Username: [required] The name 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 remove the user from, for example MyTestGroup.