v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141784109.3 KB

Creates a new user.

post/Users/CreateUser#DirectoryId

Query parameters

DirectoryIdstring required

The identifier (ID) of the directory that’s associated with the user.

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>
EmailAddressstring password

The email address of the user.

GivenNamestring password

The first name of the user.

OtherAttributesobject
<p> An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </p> <note> <p> Attribute names are case insensitive. </p> </note>
SAMAccountNamestring required

The name of the user.

Surnamestring password

The last name of the user.

Response

Success

DirectoryIdstring

The identifier (ID) of the directory where the address block is added.

SAMAccountNamestring

The name of the user.

SIDstring

The unique security identifier (SID) of the user.