Manage OAuth providers¶
The Manage OAuth providers page allows you to configure, add, remove, or modify OAuth providers for your cluster.
Configure an OAuth provider¶
DataRobot supports integration with several external OAuth providers. Refer to the links below for configuration options.
Provider | Client setup instructions | Callback URI |
---|---|---|
GitHub | Github application | DATAROBOT_BASE_URL /account/oauth-providers/ |
GitLab | Manage GitLab OAuth applications | DATAROBOT_BASE_URL /account/oauth-providers/ |
Bitbucket | Bitbucket app authorizations | DATAROBOT_BASE_URL /account/oauth-providers/ |
Google app authorizations | DATAROBOT_BASE_URL /account/oauth-providers/?providerId= PROVIDER_ID |
|
Box | Box app authorizations | DATAROBOT_BASE_URL /account/oauth-providers/?providerId= PROVIDER_ID |
Note
In the Callback URI field, substitude the URL of your deployment in place of DATAROBOT_BASE_URL
(e.g., app.DataRobot.com
). The Callback URI field is configured in the external OAuth provider's settings outside of DataRobot. For Google or Box configurations, the value for PROVIDER_ID
must be updated in the URI field after creating the OAuth provider in DataRobot. Once added, the value is the one shown in the Provider id column for the provider in the DataRobot UI.
Add an OAuth provider¶
To add a new OAuth provider:
-
In the top-right corner, go to User Settings > OAuth provider management.
-
Click Add OAuth provider.
-
Fill in the fields. Note that all fields are required:
Field Description Provider type Specify the provider. Provider Name Specify a name for the provider being added. Client ID Enter the Client ID
from the provider you want to add.Client Secret Enter the Client Secret
from the provider you want to add. -
To add the new provider, click Add.
Note
Only the user who added the provider will be able to access it for modifying or removal.
Verify an OAuth provider¶
Before an OAuth provider can be used in the cluster, it must be authorized for the user accessing the server.
To verify an OAuth provider:
-
Open the Actions menu on the right-hand side of the OAuth provider management table in the row containing your provider and select Authorize on NAME (NAME will vary based on the provider of the service).
-
Click through the subsequent steps required by the service to authorize your provider. The example below demonstrates the flow for GitHub, but other providers will differ.
-
After verification, the provider row displays an authorized badge below its name.
Modify an OAuth provider¶
To edit a configured provider:
-
Open the Actions menu on the right-hand side of the OAuth provider management table in the row containing your provider and select Edit OAuth provider.
-
Edit the necessary fields and click Update to finish.
Remove an OAuth provider¶
To remove a provider:
-
Open the Actions menu on the right-hand side of the OAuth provider management table in the row containing your provider and select Revoke authorization.
-
Click Revoke to proceed.
The provider now displays a Not authorized icon below it.
Note
The default providers cannot be removed.