WorkDocs / Client / create_user

create_user

WorkDocs.Client.create_user(**kwargs)

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is “ACTIVE”. New users can access Amazon WorkDocs.

See also: AWS API Documentation

Request Syntax

response = client.create_user(
    OrganizationId='string',
    Username='string',
    EmailAddress='string',
    GivenName='string',
    Surname='string',
    Password='string',
    TimeZoneId='string',
    StorageRule={
        'StorageAllocatedInBytes': 123,
        'StorageType': 'UNLIMITED'|'QUOTA'
    },
    AuthenticationToken='string'
)

Parameters:

• OrganizationId (string) – The ID of the organization.

• Username (string) –

  [REQUIRED]

  The login name of the user.

• EmailAddress (string) – The email address of the user.

• GivenName (string) –

  [REQUIRED]

  The given name of the user.

• Surname (string) –

  [REQUIRED]

  The surname of the user.

• Password (string) –

  [REQUIRED]

  The password of the user.

• TimeZoneId (string) – The time zone ID of the user.

• StorageRule (dict) –

  The amount of storage for the user.

  • StorageAllocatedInBytes (integer) –

    The amount of storage allocated, in bytes.

  • StorageType (string) –

    The type of storage.

• AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Id': 'string',
        'Username': 'string',
        'EmailAddress': 'string',
        'GivenName': 'string',
        'Surname': 'string',
        'OrganizationId': 'string',
        'RootFolderId': 'string',
        'RecycleBinFolderId': 'string',
        'Status': 'ACTIVE'|'INACTIVE'|'PENDING',
        'Type': 'USER'|'ADMIN'|'POWERUSER'|'MINIMALUSER'|'WORKSPACESUSER',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'ModifiedTimestamp': datetime(2015, 1, 1),
        'TimeZoneId': 'string',
        'Locale': 'en'|'fr'|'ko'|'de'|'es'|'ja'|'ru'|'zh_CN'|'zh_TW'|'pt_BR'|'default',
        'Storage': {
            'StorageUtilizedInBytes': 123,
            'StorageRule': {
                'StorageAllocatedInBytes': 123,
                'StorageType': 'UNLIMITED'|'QUOTA'
            }
        }
    }
}

Response Structure

• (dict) –

  • User (dict) –

    The user information.

    • Id (string) –

      The ID of the user.

    • Username (string) –

      The login name of the user.

    • EmailAddress (string) –

      The email address of the user.

    • GivenName (string) –

      The given name of the user.

    • Surname (string) –

      The surname of the user.

    • OrganizationId (string) –

      The ID of the organization.

    • RootFolderId (string) –

      The ID of the root folder.

    • RecycleBinFolderId (string) –

      The ID of the recycle bin folder.

    • Status (string) –

      The status of the user.

    • Type (string) –

      The type of user.

    • CreatedTimestamp (datetime) –

      The time when the user was created.

    • ModifiedTimestamp (datetime) –

      The time when the user was modified.

    • TimeZoneId (string) –

      The time zone ID of the user.

    • Locale (string) –

      The locale of the user.

    • Storage (dict) –

      The storage for the user.

      • StorageUtilizedInBytes (integer) –

        The amount of storage used, in bytes.

      • StorageRule (dict) –

        The storage for a user.

        • StorageAllocatedInBytes (integer) –

          The amount of storage allocated, in bytes.

        • StorageType (string) –

          The type of storage.

Exceptions

• WorkDocs.Client.exceptions.EntityAlreadyExistsException

• WorkDocs.Client.exceptions.UnauthorizedOperationException

• WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

• WorkDocs.Client.exceptions.FailedDependencyException

• WorkDocs.Client.exceptions.ServiceUnavailableException