ActivateUserCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, ActivateUserCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, ActivateUserCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // ActivateUserRequest
  UserId: "STRING_VALUE", // required
  AuthenticationToken: "STRING_VALUE",
};
const command = new ActivateUserCommand(input);
const response = await client.send(command);
// { // ActivateUserResponse
//   User: { // User
//     Id: "STRING_VALUE",
//     Username: "STRING_VALUE",
//     EmailAddress: "STRING_VALUE",
//     GivenName: "STRING_VALUE",
//     Surname: "STRING_VALUE",
//     OrganizationId: "STRING_VALUE",
//     RootFolderId: "STRING_VALUE",
//     RecycleBinFolderId: "STRING_VALUE",
//     Status: "ACTIVE" || "INACTIVE" || "PENDING",
//     Type: "USER" || "ADMIN" || "POWERUSER" || "MINIMALUSER" || "WORKSPACESUSER",
//     CreatedTimestamp: new Date("TIMESTAMP"),
//     ModifiedTimestamp: new Date("TIMESTAMP"),
//     TimeZoneId: "STRING_VALUE",
//     Locale: "en" || "fr" || "ko" || "de" || "es" || "ja" || "ru" || "zh_CN" || "zh_TW" || "pt_BR" || "default",
//     Storage: { // UserStorageMetadata
//       StorageUtilizedInBytes: Number("long"),
//       StorageRule: { // StorageRuleType
//         StorageAllocatedInBytes: Number("long"),
//         StorageType: "UNLIMITED" || "QUOTA",
//       },
//     },
//   },
// };

ActivateUserCommand Input

See ActivateUserCommandInput for more details

Parameter
Type
Description
UserId
Required
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.

ActivateUserCommand Output

See ActivateUserCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
User
User | undefined

The user information.

Throws

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.