v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Adds an existing user, group, or computer as a group member.

post/GroupMemberships/AddGroupMember#DirectoryId

Query parameters

DirectoryIdstring required

The identifier (ID) of the directory that's associated with the group.

Request body

ClientTokenstring
<p> 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. </p> <p> 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. </p> <p> 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 <code>ConflictException</code>. </p> <note> <p> This parameter is optional when using the CLI or SDK. </p> </note>
GroupNamestring required

The name of the group.

MemberNamestring required

The <code>SAMAccountName</code> of the user, group, or computer to add as a group member.

MemberRealmstring
<p> The domain name that's associated with the group member. This parameter is required only when adding a member outside of your Managed Microsoft AD domain to a group inside of your Managed Microsoft AD domain. This parameter defaults to the Managed Microsoft AD domain. </p> <note> <p> This parameter is case insensitive. </p> </note>

Response

Success

AddGroupMemberResult required
All 17 operations