When to Use a Custom OAuth AppCreating a custom OAuth app is optional as the component is already registered with Azure Data Management and you can connect with its embedded credentials.
You might want to create a custom OAuth app to change the information displayed when users log into Azure Data Management to grant permissions to the component.
Desktop Authentication with a Custom OAuth AppFollow the steps below to authenticate with the credentials for a custom OAuth app.
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- OAuthClientId: Set this to the client Id assigned when you registered your app.
- OAuthClientSecret: Set this to the client secret assigned when you registered your app.
- CallbackURL: Set this to the Sign-On URL you specified in your app settings.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
- SubscriptionId (optional): A subscription Id is required for Azure API Management endpoints, so if you do not specify one, the component gets the first subscription Id available in your account.
- Tenant (optional): Your tenant can be specified if you wish to authenticate to a different tenant than your default. This is required to work with a Subscription not on your default Tenant.
- Extracts the access token from the callback URL and authenticates requests.
- Refreshes the access token when it expires.
- Saves OAuth values in OAuthSettingsLocation to be persisted across connections.