WorkMail / Client / describe_user

describe_user

WorkMail.Client.describe_user(**kwargs)

Provides information regarding the user.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    OrganizationId='string',
    UserId='string'
)

Parameters:

• OrganizationId (string) –

  [REQUIRED]

  The identifier for the organization under which the user exists.

• UserId (string) –

  [REQUIRED]

  The identifier for the user to be described.

  The identifier can be the UserId, Username, or email. The following identity formats are available:

  • User ID: 12345678-1234-1234-1234-123456789012 or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: user@domain.tld

  • User name: user

Return type:

dict

Returns:

Response Syntax

{
    'UserId': 'string',
    'Name': 'string',
    'Email': 'string',
    'DisplayName': 'string',
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER'|'REMOTE_USER',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1),
    'MailboxProvisionedDate': datetime(2015, 1, 1),
    'MailboxDeprovisionedDate': datetime(2015, 1, 1),
    'FirstName': 'string',
    'LastName': 'string',
    'HiddenFromGlobalAddressList': True|False,
    'Initials': 'string',
    'Telephone': 'string',
    'Street': 'string',
    'JobTitle': 'string',
    'City': 'string',
    'Company': 'string',
    'ZipCode': 'string',
    'Department': 'string',
    'Country': 'string',
    'Office': 'string',
    'IdentityProviderUserId': 'string',
    'IdentityProviderIdentityStoreId': 'string'
}

Response Structure

• (dict) –

  • UserId (string) –

    The identifier for the described user.

  • Name (string) –

    The name for the user.

  • Email (string) –

    The email of the user.

  • DisplayName (string) –

    The display name of the user.

  • State (string) –

    The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).

  • UserRole (string) –

    In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, SYSTEM_USER, and REMOTE_USER.

  • EnabledDate (datetime) –

    The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.

  • DisabledDate (datetime) –

    The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.

  • MailboxProvisionedDate (datetime) –

    The date when the mailbox was created for the user.

  • MailboxDeprovisionedDate (datetime) –

    The date when the mailbox was removed for the user.

  • FirstName (string) –

    First name of the user.

  • LastName (string) –

    Last name of the user.

  • HiddenFromGlobalAddressList (boolean) –

    If enabled, the user is hidden from the global address list.

  • Initials (string) –

    Initials of the user.

  • Telephone (string) –

    User’s contact number.

  • Street (string) –

    Street where the user is located.

  • JobTitle (string) –

    Job title of the user.

  • City (string) –

    City where the user is located.

  • Company (string) –

    Company of the user.

  • ZipCode (string) –

    Zip code of the user.

  • Department (string) –

    Department of the user.

  • Country (string) –

    Country where the user is located.

  • Office (string) –

    Office where the user is located.

  • IdentityProviderUserId (string) –

    User ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

  • IdentityProviderIdentityStoreId (string) –

    Identity Store ID from the IAM Identity Center. If this parameter is empty it will be updated automatically when the user logs in for the first time to the mailbox associated with WorkMail.

Exceptions

• WorkMail.Client.exceptions.DirectoryServiceAuthenticationFailedException

• WorkMail.Client.exceptions.DirectoryUnavailableException

• WorkMail.Client.exceptions.EntityNotFoundException

• WorkMail.Client.exceptions.InvalidParameterException

• WorkMail.Client.exceptions.OrganizationNotFoundException

• WorkMail.Client.exceptions.OrganizationStateException