Admin Add User To Group
cognitoidentityprovider_admin_add_user_to_group | R Documentation |
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.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Learn more
Usage¶
Arguments¶
UserPoolId
[required] The user pool ID for the user pool.
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 thesub
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.
Value¶
An empty list.