WorkMail / Client / describe_user

describe_user#

WorkMail.Client.describe_user(**kwargs)#

Provides information regarding the user.

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.

Return type:

dict

Returns:

Response Syntax

{
    'UserId': 'string',
    'Name': 'string',
    'Email': 'string',
    'DisplayName': 'string',
    'State': 'ENABLED'|'DISABLED'|'DELETED',
    'UserRole': 'USER'|'RESOURCE'|'SYSTEM_USER',
    'EnabledDate': datetime(2015, 1, 1),
    'DisabledDate': datetime(2015, 1, 1)
}

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, and SYSTEM_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.

Exceptions

WorkMail.Client.exceptions.EntityNotFoundException
WorkMail.Client.exceptions.InvalidParameterException
WorkMail.Client.exceptions.OrganizationNotFoundException
WorkMail.Client.exceptions.OrganizationStateException