GetAuthenticationUrl
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.
Request Syntax
POST /participant/authentication-url HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json
{
"RedirectUri": "string
",
"SessionId": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- ConnectionToken
-
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- RedirectUri
-
The URL where the customer will be redirected after Amazon Cognito authorizes the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- SessionId
-
The sessionId provided in the authenticationInitiated event.
Type: String
Length Constraints: Fixed length of 36.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AuthenticationUrl": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AuthenticationUrl
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2083.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- InternalServerException
-
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: