AddGroupMember
Adds an existing user, group, or computer as a group member.
Request Syntax
POST /GroupMemberships/AddGroupMember?DirectoryId=DirectoryId HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"GroupName": "string",
"MemberName": "string",
"MemberRealm": "string"
}URI Request Parameters
The request uses the following URI parameters.
- DirectoryId
-
The identifier (ID) of the directory that's associated with the group.
Pattern:
^d-[0-9a-f]{10}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.
If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an
ConflictException.Note
This parameter is optional when using the AWS CLI or SDK.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\x00-\x7F]+$Required: No
- GroupName
-
The name of the group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[^:;|=+"*?<>/\\,\[\]@]+$Required: Yes
- MemberName
-
The
SAMAccountNameof the user, group, or computer to add as a group member.Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[^:;|=+"*?<>/\\,\[\]@]+$Required: Yes
- MemberRealm
-
The domain name that's associated with the group member. This parameter is required only when adding a member outside of your AWS Managed Microsoft AD domain to a group inside of your AWS Managed Microsoft AD domain. This parameter defaults to the AWS Managed Microsoft AD domain.
Note
This parameter is case insensitive.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+[.]?$Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have permission to perform the request or access the directory. It can also occur when the
DirectoryIddoesn't exist or the user, member, or group might be outside of your organizational unit (OU).Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU.
HTTP Status Code: 403
- ConflictException
-
This error will occur when you try to create a resource that conflicts with an existing object. It can also occur when adding a member to a group that the member is already in.
This error can be caused by a request sent within the 8-hour idempotency window with the same client token but different input parameters. Client tokens should not be re-used across different requests. After 8 hours, any request with the same client token is treated as a new request.
HTTP Status Code: 409
- DirectoryUnavailableException
-
The request could not be completed due to a problem in the configuration or current state of the specified directory.
HTTP Status Code: 400
- InternalServerException
-
The operation didn't succeed because an internal error occurred. Try again later.
HTTP Status Code: 500
- ResourceNotFoundException
-
The resource couldn't be found.
HTTP Status Code: 404
- ThrottlingException
-
The limit on the number of requests per second has been exceeded.
HTTP Status Code: 429
- ValidationException
-
The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of AddGroupMember.
Sample Request
{
"ClientToken": "550e8400-e29b-41d4-a716-446655440000",
"GroupName": "GRP_MKTG",
"MemberName": "Pat Candella",
"MemberRealm": "europe.example.com"
}Sample Response
HTTP/1.1 200See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
