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

ActivateUser

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.

Activates the specified user. Only active users can access Amazon WorkDocs.

Request Syntax


POST /api/v1/users/UserId/activation HTTP/1.1
Authentication: AuthenticationToken

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.

UserId

The ID of the user.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
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 200 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.

EntityNotExistsException

The resource does not exist.

HTTP Status Code: 404

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