OAuth 2.0 Password Grant

Overview

The OAuthPassword is an authentication method where the application exchanges the username and password for an access token.

Fields

OAuth 2.0 Password Grant authentication includes the following fields:

Fields	Description
Client Id	A unique identifier assigned to the client application by the authorization server.
Client Secret	A confidential string used by the client to authenticate itself to the authorization server.
Username	This field is the username of a user for the external system that you want to integrate
Password	This field is the password of a user of the external system that you want to integrate
Grant Type	By default is password. However, there are other grant types used in OAuth 2.0 and the 'password' can be replaced according to the authorization flow of the external system.
Headers	This field is used when any extra headers are needed to be added for the authorization.
Access Token URL	The URL where the client exchanges the authorization code for an access token.
Refresh Token URL	The Refresh Token URL is the endpoint in the OAuth 2.0 authorization server where a client can request a new access token using a refresh token. This URL is used when the current access token expires to obtain a new one without requiring the user to re-authenticate.
Use Raw Token	This checkbox needs to be enabled only when the prefix 'Bearer' needs not to be added in front of the token. After obtaining the authorization token, we must decide whether to include the 'Bearer' prefix before appending it to the request for the ingestion part. This is accomplished using this checkbox flag.
Body Parameters	Use this field to include extra form parameters for authentication, which will be added as the request body. This field accepts values using the JSON format {"key":"value"}.

Not all fields are required. Only fields with an asterisk by them are required. Required combinations of fields differ based on the specific requirements of the external system.

How it Works

This is an industry standard authorization flow. The Password grant is used when the application exchanges the user’s username and password for an access token.

Configuring the external platform

When configuring the external system for OAuth 2.0 integration with the Aisera platform, the following redirect URLs may need to be whitelisted.

Service Account Authorization

For service account authorization for use with the data sources and workflows whitelist:

https://<cluster_id>.login.aisera.<top_level_domain>/?id=aisera.oauth.oauthCommand

Contact your Aisera support team for the Cluster Id.

User Authorization

For user authorization for use with workflows whitelist:

https://<vanity_url>.chatbot.aisera.<top_level_domain>/oauth2/authorize