IMPORTANT: This documentation has been discontinued. Read the updated Registration of new OAuth providers documentation on our new documentation portal.
OAuth 2.0 is a token-based authorization protocol that allows an application to access a user's resources and information without requiring their credentials.
Until now, it was possible to integrate new OAuth2 providers through a request to the support team. Knowing that this process limited our customers’ decisions and performance, we have implemented a new OAuth2 architecture in which the Digibee Platform user will be able to register new providers and use them in their integrations independently and autonomously.
Thus, it is now possible to add new OAuth providers through the existing ones on the Digibee Platform, all you need is the Client ID and Client Secret of your OAuth application. To learn how to create your application, read the article New OAuth2 Architecture.
Once the application is created on the provider, it will be possible to register your new OAuth2 provider on the Digibee Platform following the tutorial below:
1. How to register a new provider
In Settings, access the Account screen. On this screen, click on the “OAuth provider” submenu. Here, it will be possible to register new providers from an existing provider registered in the Digibee Platform.
So, to create a new provider, click + CREATE. Then, you can configure the authentication of the new provider through an existing one so it can be used in your pipeline later.
2. Define the settings of the new provider
On this screen, select an existing base provider registered in the Digibee Platform so that the Auth URL field is automatically filled in. You will also need to define the name of your new provider according to the example below:
Once this step is completed, click on the “Continue” button.
3. Configure the credentials to access the provider
After entering the details of the new provider, you need to configure the credentials to be able to access it. In this step, you will need the Client ID and Client Secret, which are the OAuth authentication keys (to learn how to get them, read the article New OAuth2 Architecture.)
Furthermore, it will also be necessary to inform the scopes of the provider that you want to use in your application, that is, the actions that you will be allowing the platform to do through this provider. See the example below:
After entering all the requested information, to finalize the process of creating the new provider, click on the "Finish" button, which will redirect you to the “OAuth provider” screen. On this screen, your new provider will now be available for use.
Once the new provider is created, it will be possible to manage, edit and even delete it in the “OAuth providers” screen.
Terms of Use
When using the OAuth Architecture, you automatically make your adhesion to the Beta program and agree with the terms of use. You can find more information about beta versions by clicking here.