Connect / Client / update_user_identity_info

update_user_identity_info#

Connect.Client.update_user_identity_info(**kwargs)#

Updates the identity information for the specified user.

Warning

We strongly recommend limiting who has the ability to invoke UpdateUserIdentityInfo. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker’s email address, and then reset the password through email. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_user_identity_info(
    IdentityInfo={
        'FirstName': 'string',
        'LastName': 'string',
        'Email': 'string',
        'SecondaryEmail': 'string',
        'Mobile': 'string'
    },
    UserId='string',
    InstanceId='string'
)
Parameters:

  • IdentityInfo (dict) –

    [REQUIRED]

    The identity information for the user.

    • FirstName (string) –

      The first name. This is required if you are using Amazon Connect or SAML for identity management.

    • LastName (string) –

      The last name. This is required if you are using Amazon Connect or SAML for identity management.

    • Email (string) –

      The email address. If you are using SAML for identity management and include this parameter, an error is returned.

    • SecondaryEmail (string) –

      The user’s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

      Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

    • Mobile (string) –

      The user’s mobile number.

  • UserId (string) –

    [REQUIRED]

    The identifier of the user account.

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.InternalServiceException