CancelParticipantAuthentication

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

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

Request Syntax


POST /participant/cancel-authentication HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json

{
   "SessionId": "string"
}

The request uses the following URI parameters.

The authentication token associated with the participant's connection.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

The request accepts the following data in JSON format.

The sessionId provided in the authenticationInitiated event.

Type: String

Length Constraints: Fixed length of 36.

Required: Yes


HTTP/1.1 200

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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