Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateUser

Important

Notice: New customer sign-ups and account upgrades are no longer available for Amazon WorkDocs. Learn about migration steps here: How to migrate data from Amazon WorkDocs.

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.

Request Syntax


POST /api/v1/users HTTP/1.1
Authentication: AuthenticationToken
Content-type: application/json

{
   "EmailAddress": "string",
   "GivenName": "string",
   "OrganizationId": "string",
   "Password": "string",
   "StorageRule": { 
      "StorageAllocatedInBytes": number,
      "StorageType": "string"
   },
   "Surname": "string",
   "TimeZoneId": "string",
   "Username": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AuthenticationToken

Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

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

Request Body

The request accepts the following data in JSON format.

EmailAddress

The email address of the user.

Type: String

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

Pattern: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}

Required: No

GivenName

The given name of the user.

Type: String

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

Required: Yes

OrganizationId

The ID of the organization.

Type: String

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

Pattern: [&\w+-.@]+

Required: No

Password

The password of the user.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 32.

Pattern: [\u0020-\u00FF]+

Required: Yes

StorageRule

The amount of storage for the user.

Type: StorageRuleType object

Required: No

Surname

The surname of the user.

Type: String

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

Required: Yes

TimeZoneId

The time zone ID of the user.

Type: String

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

Required: No

Username

The login name of the user.

Type: String

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

Pattern: [\w\-+.]+(@[a-zA-Z0-9.\-]+\.[a-zA-Z]+)?

Required: Yes

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "User": { 
      "CreatedTimestamp": number,
      "EmailAddress": "string",
      "GivenName": "string",
      "Id": "string",
      "Locale": "string",
      "ModifiedTimestamp": number,
      "OrganizationId": "string",
      "RecycleBinFolderId": "string",
      "RootFolderId": "string",
      "Status": "string",
      "Storage": { 
         "StorageRule": { 
            "StorageAllocatedInBytes": number,
            "StorageType": "string"
         },
         "StorageUtilizedInBytes": number
      },
      "Surname": "string",
      "TimeZoneId": "string",
      "Type": "string",
      "Username": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

User

The user information.

Type: User object

Errors

For information about the errors that are common to all actions, see Common Errors.

EntityAlreadyExistsException

The resource already exists.

HTTP Status Code: 409

FailedDependencyException

The AWS Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.

HTTP Status Code: 424

ServiceUnavailableException

One or more of the dependencies is unavailable.

HTTP Status Code: 503

UnauthorizedOperationException

The operation is not permitted.

HTTP Status Code: 403

UnauthorizedResourceAccessException

The caller does not have access to perform the action on the resource.

HTTP Status Code: 404