:doc:`ConnectParticipant <../../connectparticipant>` / Client / cancel_participant_authentication

*********************************
cancel_participant_authentication
*********************************



.. py:method:: ConnectParticipant.Client.cancel_participant_authentication(**kwargs)

  

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

   

  .. note::

    

    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 <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/connectparticipant-2018-09-07/CancelParticipantAuthentication>`_  


  **Request Syntax**
  ::

    response = client.cancel_participant_authentication(
        SessionId='string',
        ConnectionToken='string'
    )
    
  :type SessionId: string
  :param SessionId: **[REQUIRED]** 

    The ``sessionId`` provided in the ``authenticationInitiated`` event.

    

  
  :type ConnectionToken: string
  :param ConnectionToken: **[REQUIRED]** 

    The authentication token associated with the participant's connection.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`ConnectParticipant.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`ConnectParticipant.Client.exceptions.InternalServerException`

  
  *   :py:class:`ConnectParticipant.Client.exceptions.ThrottlingException`

  
  *   :py:class:`ConnectParticipant.Client.exceptions.ValidationException`

  