Add an External Authentication Credential in Sprinklr

Updated 

In this article, you will learn about how to add an External Authentication Credential in Sprinklr.

Note

  • Sprinklr supports all types of authentications.

  • For static authentication (Key based), you are not required to add any external authentication credential in Sprinklr.

To Add an External Authentication Credential

  1. Click the New Tab icon Space Add New Tab Icon. Under the Platform Module, click All Settings within Listen.

  2. In the Platform Settings window, click Manage Customer and select External Authentication Credential from the list of options. You can also search for it in the search bar above.

  3. In the External Authentication Credential window, click Add Credential in the top right corner.

  4. In the Add External Authentication Credential window, enter the External Credential Name.

  5. Next, select the Authentication Type from the drop-down menu. The following options are available:

    • Basic Auth

    • Client Credentials Auth

    • OAuth 1.0

    • JWT Auth

    • OAuth Refresh Token

    • Password Auth

    • Custom Auth

  6. Based upon the selected authentication type, different options are available.

    Note

    For static authentication (Key based), you are not required to add any external authentication credential in Sprinklr.

  7. Click Save in the bottom right corner of the Add External Authentication Credential window.

Authentication Type — Field Descriptions

Field

Descriptions

Basic Auth

User Name

Enter the username for the authentication.

Password

Enter the password for the authentication.

Client Credentials Auth

Token Url

Enter the endpoint URL for token generation

Custom Token Header

Enter custom headers (if available). This will override the standard authorization headers

Client Id

Enter the Client ID required for token generation

Client Secret

Enter the client secret required for token generation

Scope

Enter the scope of the authorization process (if available)

Request Via Proxy

Toggle for enabling requesting the API through proxy

OAuth 1.0 

Client ID 

Enter the Client ID for the authentication. This option is available for Client Credentials, Password Credentials and Refresh Token.

Client Secret 

Enter the client secret key for the authentication. This option is available for Client Credentials, Password Credentials and Refresh Token.

Add auth data to

Add auth data to either header or request

Access Token 

Enter the access token

Access Token Secret 

Enter the access token secret

JWT Auth

JWT Claims

Enter the JWT claims and the corresponding values. Please note that you can add multiple claims by clicking on the (+) button

JWT Headers

Enter the JWT headers and the corresponding values. Please note that you can add multiple headers by clicking on the (+) button

Signature Algorithm

Enter the signature algorithm for JWT token generation

JWT Secret

Enter the secret for JWT token generation

Request Adapter

Enter the request adapter for JWT token generation

Response Adapter

Enter the response adapter for JWT token generation

Custom Claim Adapter

Enter the custom claim adapter for JWT token generation

Request via Proxy

Toggle for enabling requesting the API through proxy

OAuth Refresh Token

Client ID

Enter the Client ID for the authentication.

Client Secret

Enter the Client Secret Key for the authentication.

OAuth Token

Enter the OAuth Token for the authentication.

Password Auth

User Name

Enter the username for the authentication.

Password

Enter the password for the authentication.

Client ID

Enter the Client ID for the authentication.

Client Secret

Enter the Client Secret Key for the authentication

Custom Auth

Token URL

Enter the endpoint URL for token generation

Content Type

Enter the valid content-type for token generation

Custom Token Header

Enter the custom headers required for token generation. This will override the standard authorization header

Custom Headers

Enter the custom headers required for token generation

Custom Parameters

Enter the custom parameters required for token generation. Please note that you can add multiple parameters by clicking on the (+) button

HTTP Method

Enter the HTTP method required to generate the token

Request Adapter

Enter the request adapter for token generation

Response Adapter

Enter the response adapter for token generation

Request Via Proxy

Toggle for enabling requesting the API through proxy