WorkMail / Client / update_user

update_user#

WorkMail.Client.update_user(**kwargs)#

Updates data for the user. To have the latest information, it must be preceded by a DescribeUser call. The dataset in the request should be the one expected when performing another DescribeUser call.

See also: AWS API Documentation

Request Syntax

response = client.update_user(
    OrganizationId='string',
    UserId='string',
    Role='USER'|'RESOURCE'|'SYSTEM_USER'|'REMOTE_USER',
    DisplayName='string',
    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'
)
Parameters:

  • OrganizationId (string) –

    [REQUIRED]

    The identifier for the organization under which the user exists.

  • UserId (string) –

    [REQUIRED]

    The identifier for the user to be updated.

    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

  • Role (string) –

    Updates the user role.

    You cannot pass SYSTEM_USER or RESOURCE.

  • DisplayName (string) – Updates the display name of the user.

  • FirstName (string) – Updates the user’s first name.

  • LastName (string) – Updates the user’s last name.

  • HiddenFromGlobalAddressList (boolean) – If enabled, the user is hidden from the global address list.

  • Initials (string) – Updates the user’s initials.

  • Telephone (string) – Updates the user’s contact details.

  • Street (string) – Updates the user’s street address.

  • JobTitle (string) – Updates the user’s job title.

  • City (string) – Updates the user’s city.

  • Company (string) – Updates the user’s company.

  • ZipCode (string) – Updates the user’s zip code.

  • Department (string) – Updates the user’s department.

  • Country (string) – Updates the user’s country.

  • Office (string) – Updates the user’s office.

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

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

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

  • WorkMail.Client.exceptions.UnsupportedOperationException

  • WorkMail.Client.exceptions.EntityStateException