- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeactivateUserCommand
Deactivates the specified user, which revokes the user's access to Amazon WorkDocs.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WorkDocsClient, DeactivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DeactivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DeactivateUserRequest
UserId: "STRING_VALUE", // required
AuthenticationToken: "STRING_VALUE",
};
const command = new DeactivateUserCommand(input);
const response = await client.send(command);
// {};
DeactivateUserCommand Input
See DeactivateUserCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
UserIdRequired | string | undefined | The ID of the user. |
AuthenticationToken | string | undefined | Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API. |
DeactivateUserCommand Output
See DeactivateUserCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| EntityNotExistsException | client | The resource does not exist. |
| FailedDependencyException | client | The 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. |
| ServiceUnavailableException | server | One or more of the dependencies is unavailable. |
| UnauthorizedOperationException | client | The operation is not permitted. |
| UnauthorizedResourceAccessException | client | The caller does not have access to perform the action on the resource. |
| WorkDocsServiceException | Base exception class for all service exceptions from WorkDocs service. |