Establishing an OAuth Provider
- 31 May 2022
- 1 Minute to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Establishing an OAuth Provider
- Updated on 31 May 2022
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
OAuth is an open standard for providing secured delegated access. In short, Decisions can take actions or access resources from a server on behalf of the user, without them having to share their credentials. It does this by allowing the identity provider (IdP) to issue tokens to Decisions with the user’s approval. Before using an API with OAuth, two things must first occur an OAuth Provider must be established, and an OAuth Token must be created. The following document discusses the method used to set up an OAuth Provider for proper Integration with Decisions.
Adding a Provider
- Navigate to System > Integrations > Providers and click ADD OAUTH PROVIDER.
- Once selected the user may define the Provider's Name and a Description, and then, the following Provider Settings. Once all necessary configurations have been made, click SAVE to finish adding the OAuth Provider.
Setting Name Description OAuth Version Allows the user to define which version of OAuth is used in the Provider (OAuth1x or OAuth2) Token Request URL Allows the ability to request a Token from the Integrated Service Authorize URL Enables access to the API Callback URL (OAuth2) URL that is designated to receive auth code. Example: {BasePortalURL}/HandleTokenResponse Token Refresh URL (optional) (OAuth2) This allows the ability to access the API again, after expiration without inputting additional credentials Default Consumer Key Used as a means to identify the user or service that interacts with the API Default Consumer Secret Key Acts in conjunction with the Default Consumer Key as a password to allow access to the API's functions URL Encode Refresh Token During Refresh URL Encodes refresh token during refresh Omit Code During Refresh Removes Oauth process code during the refresh process
For further information on Integrations, visit the Decisions Forum.
Was this article helpful?