GETAUTHENTICATIONURL()`¶

About GetAuthenticationUrl¶

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

For security recommendations, see Amazon Connect 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.

Method Signature¶

METHODS /AWS1/IF_CNP~GETAUTHENTICATIONURL
  IMPORTING
    !IV_SESSIONID TYPE /AWS1/CNPSESSIONID OPTIONAL
    !IV_REDIRECTURI TYPE /AWS1/CNPREDIRECTURI OPTIONAL
    !IV_CONNECTIONTOKEN TYPE /AWS1/CNPPARTICIPANTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cnpgetauthntctnurlrsp
  RAISING
    /AWS1/CX_CNPACCESSDENIEDEX
    /AWS1/CX_CNPINTERNALSERVEREX
    /AWS1/CX_CNPTHROTTLINGEX
    /AWS1/CX_CNPVALIDATIONEX
    /AWS1/CX_CNPCLIENTEXC
    /AWS1/CX_CNPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_sessionid` `TYPE /AWS1/CNPSESSIONID` `/AWS1/CNPSESSIONID`¶

The sessionId provided in the authenticationInitiated event.

`iv_redirecturi` `TYPE /AWS1/CNPREDIRECTURI` `/AWS1/CNPREDIRECTURI`¶

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

`iv_connectiontoken` `TYPE /AWS1/CNPPARTICIPANTTOKEN` `/AWS1/CNPPARTICIPANTTOKEN`¶

The authentication token associated with the participant's connection.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cnpgetauthntctnurlrsp` `/AWS1/CL_CNPGETAUTHNTCTNURLRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getauthenticationurl(
  iv_connectiontoken = |string|
  iv_redirecturi = |string|
  iv_sessionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_authenticationurl = lo_result->get_authenticationurl( ).
ENDIF.

/AWS1/IF_CNP=>GETAUTHENTICATIONURL()¶