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
Deletes the specified user from a Simple AD or Microsoft AD directory.
Important
Deleting a user immediately and permanently deletes all content in that user's folder structure. Site retention policies do NOT apply to this type of deletion.
Request Syntax
DELETE /api/v1/users/UserId HTTP/1.1
Authentication: AuthenticationToken
URI Request Parameters
The request uses the following URI parameters.
- AuthenticationToken
-
Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
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 204
Response Elements
If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
