delete_user

delete_user(**kwargs)

Deletes the specified user from a Simple AD or Microsoft AD directory.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    AuthenticationToken='string',
    UserId='string'
)
Parameters
  • AuthenticationToken (string) -- Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using Amazon Web Services credentials.
  • UserId (string) --

    [REQUIRED]

    The ID of the user.

Returns

None

Exceptions

  • WorkDocs.Client.exceptions.EntityNotExistsException
  • WorkDocs.Client.exceptions.UnauthorizedOperationException
  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException
  • WorkDocs.Client.exceptions.FailedDependencyException
  • WorkDocs.Client.exceptions.ServiceUnavailableException