An OAuth Integration allows Asite to securely connect with external applications and APIs using OAuth 2.0 authentication. This allows Asite to exchange data with third-party systems using access tokens instead of user passwords.
What is OAuth?
OAuth 2.0 is a secure, authorisation framework that allows one application to access another application’s resources using temporary access tokens. This means external systems can be accessed securely without exposing user credentials.
Main Features
Secure OAuth 2.0 based authentication.
Simple integration setup and configuration.
Secure access to external APIs using access tokens.
Real time communication with third-party applications.
Supported OAuth Grant Type
External OAuth Integration currently supports the client_credentials grant type. This grant type is used for secure system-to-system communication between Asite and an external application or service.
NOTE: User login or interaction is not required during the authentication process.
Prerequisites
Required Privileges
The following privileges are required to configure and manage External OAuth Integrations.
Privilege | Description |
Can Manage Integrations - Own Org | Allows users to create, manage, and update integrations for their own organisation. |
Enable External OAuth Integration - Own Org | Allows users to enable External OAuth integrations for their own organisation. |
NOTE: These privileges are enabled by Asite Support at a user level. They must be granted to the user configuring the integration. To request access, contact support@asite.com.
System Requirements
The following requirement must be met to use this feature.
Requirement | Description |
External OAuth Connector | Required to configure and use External OAuth Integrations. |
NOTE: For assistance with this requirement, contact support@asite.com.
How Do I Create an External OAuth Integration?
Log in to Asite.
Click More from the top bar.
Select Admin from the dropdown.
Select Integrations.
On the Integrations listing page, click Create Integration (top-right).
Select External OAuth from the dropdown.
In the pop-up window, enter the required details.
For additional information on these fields, see Available Options When Creating an Integration.
Click Save (bottom-right).
The External OAuth will be created.
External OAuth Integration Options
Name | Function |
Integration | Select External OAuth. |
Organisation | Select the organisation name. |
Enter or select the Asite email ID from the dropdown. | |
OAuth Grant Type | Select the OAuth grant type. External OAuth Integration currently supports client_credentials only. |
Client ID | Enter your OAuth Client ID provided by an external application or service. |
Secret | Enter the secret key provided by the external application or service. |
Access Token URL | Enter the URL used to generate the access token. |
Scope | Enter the access permissions required for the integration. |
Metadata | Enter any additional OAuth configuration details required by the provider. |
TIP: Obtain the Client ID, Secret, Access Token URL, and Scope from the external API or OAuth provider before creating the integration.
NOTE: The Access Token URL must be reachable from the environment where the integration is configured.
Use an External OAuth Integration
After the External OAuth Integration is created, it can be used when creating external API Connections in Asite.
External API connections use the configured OAuth details to generate access tokens to securely communicate with third-party systems.
For more information, see Set Up an API Connection in AppBuilder.