Configuring OAuth Connection Settings

Open Authorization (OAuth) is a token-based technique of authentication and authorization used to provide Single Sign On (SSO).

This technique allows the user’s account information to be used by third-party applications / service without revealing the user’s password.It acts as an intermediary on behalf of the end user, providing the service with an access token that authorizes specific account information to be shared. The SSO OAuth section allows you to configure and manage OAuth connection. For a more in-depth guide click below.

Setting Up a New OAuth Connection

  1. Access OAuth Settings: Navigate to Adv. Configuration > SSO - OAuth in your application’s settings.

  2. Create New Connection: Click on the Create New Connection button to start setting up a new OAuth connection.

  3. Fill in Connection Details:

    • Enter or select the necessary information in each field.

    • Use the provided table (located below this guide) for guidance on each field's name and purpose.

  4. Review and Save: Carefully review all entered values to ensure accuracy and completeness. Then, click the Save Connection button to finalize the configuration.

  5. Successful Configuration: Once saved, your OAuth connection will be successfully configured and operational for SSO.

Managing Existing OAuth Connections

  1. Edit a Connection:

    • To modify an existing connection, navigate to the Existing Connections section.

    • Click on the desired connection, then select the Edit Connection button.

    • Update the necessary fields and click Save Connection to apply changes.

  2. Delete a Connection:

    • In the Existing Connections section, select the connection you wish to remove.

    • Click the Delete Connection button to permanently remove the OAuth connection.

Note: Authorization URL, Access Token URL and User Detail URL should be specified for Enterprise applications and can be left blank for Standard applications. If left blank, the default values will be used i.e. Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Access Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token User Detail URL: https://graph.microsoft.com/v1.0/me

FieldDescription

Provider Type

Provider type for which you want to create the new connection. The available options are Microsoft Office 365, Microsoft ADFS, and OpenId Connect.

Redirect URLs

URI(s) to which the authorization server will send the user to after the app has been successfully authorized, and granted an authorization code or access token.

Connection Name

Name that will be used to identify the connection.

Client Id

Unique ID assigned to the application registered with the OAuth provider.

Client secret

Secret code assigned to the application registered with the OAuth provider.

Authorization URL

URL to which the frontend will redirect the user for authorization.

Access Token URL

URL which should be called for obtaining the access token.

User Detail URL

URL which should be called for obtaining the user details.

Last updated