Skip to main content

AddUserToGroup

Adds the specified user to the specified group.

Permissions

ActionDescriptionResource
AddUserToGroupGrants permission to add an IAM user to the specified IAM groupgroup

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

GroupName

The name of the group to update.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w+=,.@-]+

Required: Yes

UserName

The email of the user to add.

Type: String

Pattern: [\w+=,.@-]+

Required: Yes

Errors

LimitExceeded

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

HTTP Status Code: 409

NoSuchEntity

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.

HTTP Status Code: 404

ServiceFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

Examples

Example

This example illustrates one usage of AddUserToGroup.

https://<partition>.iam.astran.io/?Action=AddUserToGroup
&GroupName=Managers
&UserName=Bob
&Version=2010-05-08
&AUTHPARAMS
<AddUserToGroupResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</AddUserToGroupResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: