authentication_urls

Creates, updates, deletes, gets or lists an authentication_urls resource.

Overview

Name	authentication_urls
Type	Resource
Id	aws.connectparticipant.authentication_urls

Fields

The following fields are returned by SELECT queries:

get_authentication_url

Name	Datatype	Description
authentication_url	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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_authentication_url	select	X-Amz-Bearer, region		Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Connect Customer Chat security best practices. 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. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
X-Amz-Bearer	string	The authentication token associated with the participant's connection.
region	string	AWS region (default: us-east-1)

SELECT examples

get_authentication_url

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Connect Customer Chat security best practices. 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. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

SELECT
authentication_url
FROM aws.connectparticipant.authentication_urls
WHERE `X-Amz-Bearer` = '{{ X-Amz-Bearer }}' -- required
AND region = '{{ region }}' -- required
;