Skip to content

update_user_identity_info

update_user_identity_info(
    identity_info: UserIdentityInfo,
    user_id: UserId,
    instance_id: InstanceId,
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> None

Updates the identity information for the specified user.

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 Connect Customer Administrator Guide.

Parameters:

  • identity_info (UserIdentityInfo) –

    The identity information for the user.

  • user_id (UserId) –

    The identifier of the user account.

  • instance_id (InstanceId) –

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

Raises:

Source code in docs_src/capo_connect/_services/connect.py
def update_user_identity_info(
    self,
    identity_info: "capo_connect.types.user_identity_info.UserIdentityInfo",
    user_id: "capo_connect.types.user_id.UserId",
    instance_id: "capo_connect.types.instance_id.InstanceId",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
) -> None:
    """<p>Updates the identity information for the specified user.</p> <important> <p>We strongly recommend limiting who has the ability to invoke <code>UpdateUserIdentityInfo</code>. 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 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html">Best Practices for Security Profiles</a> in the <i>Connect Customer Administrator Guide</i>.</p> </important>

    Args:
        identity_info: <p>The identity information for the user.</p>
        user_id: <p>The identifier of the user account.</p>
        instance_id: <p>The identifier of the Connect Customer instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.update_user_identity_info_request.UpdateUserIdentityInfoRequest]",
    ) -> OperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.update_user_identity_info

        output, http_response = (
            capo_connect._operations.amazon_connect_service.update_user_identity_info.update_user_identity_info(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_connect.types.update_user_identity_info_request.UpdateUserIdentityInfoRequest",
    ) -> dict[str, Any]:
        import capo_connect.types.update_user_identity_info_request

        return (
            capo_connect.types.update_user_identity_info_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateUserIdentityInfo", redact_input=_redact_input),
    )
    input_: capo_connect.types.update_user_identity_info_request.UpdateUserIdentityInfoRequest = {
        "identity_info": identity_info,
        "user_id": user_id,
        "instance_id": instance_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output