WorkDocs / Client / get_current_user

get_current_user

WorkDocs.Client.get_current_user(**kwargs)

Retrieves details of the current user for whom the authentication token was generated. This is not a valid action for SigV4 (administrative API) clients.

This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see Authentication and Access Control for User Applications in the Amazon WorkDocs Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_current_user(
    AuthenticationToken='string'
)

Parameters:

AuthenticationToken (string) –

[REQUIRED]

Amazon WorkDocs authentication token.

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) –

    Metadata of the user.

    • 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.EntityNotExistsException

• WorkDocs.Client.exceptions.UnauthorizedOperationException

• WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

• WorkDocs.Client.exceptions.FailedDependencyException

• WorkDocs.Client.exceptions.ServiceUnavailableException