POST

/api/v1/users

http://workdocs.{region}.amazonaws.com/api/v1/users

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Access Token Required: API Key

Body Params

Surnamestringrequired

The surname of the user.

Passwordstringrequired

The password of the user.

Usernamestringrequired

The login name of the user.

GivenNamestringrequired

The given name of the user.

TimeZoneIdstring

The time zone ID of the user.

StorageRuleobject

Describes the storage for a user.

EmailAddressstring

The email address of the user.

OrganizationIdstring

The ID of the organization.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://workdocs.{region}.amazonaws.com/api/v1/users' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}