ConnectParticipant / Client / get_authentication_url

get_authentication_url

ConnectParticipant.Client.get_authentication_url(**kwargs)

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

For security recommendations, see Amazon Connect Chat security best practices.

Note

  • This API can only be called within one minute of receiving the authenticationInitiated event.

  • The current supported channel is chat. This API is not supported for Apple Messages for Business, WhatsApp, or SMS chats.

Note

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See also: AWS API Documentation

Request Syntax

response = client.get_authentication_url(
    SessionId='string',
    RedirectUri='string',
    ConnectionToken='string'
)
Parameters:

  • SessionId (string) –

    [REQUIRED]

    The sessionId provided in the authenticationInitiated event.

  • RedirectUri (string) –

    [REQUIRED]

    The URL where the customer will be redirected after Amazon Cognito authorizes the user.

  • ConnectionToken (string) –

    [REQUIRED]

    The authentication token associated with the participant’s connection.

Return type:

dict

Returns:

Response Syntax

{
    'AuthenticationUrl': 'string'
}

Response Structure

  • (dict) –

    • AuthenticationUrl (string) –

      The URL where the customer will sign in to the identity provider. This URL contains the authorize endpoint for the Cognito UserPool used in the authentication.

Exceptions