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

**********************
get_authentication_url
**********************



.. py:method:: 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 <https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat>`__.

   

  .. 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 <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/GetAuthenticationUrl>`_  


  **Request Syntax**
  ::

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

    The sessionId provided in the authenticationInitiated event.

    

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

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

    

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

    The authentication token associated with the participant's connection.

    

  
  
  :rtype: 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**
  
  *   :py:class:`ConnectParticipant.Client.exceptions.AccessDeniedException`

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

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

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

  