FireDAC Components for Azure Data Management

Build 20.0.7587

Creating a Custom OAuth App

When to Create a Custom OAuth App

Creating a custom OAuth app is required in the web flow. Creating a custom OAuth app is optional for desktop and headless applications; 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 the Azure Data Management OAuth endpoint to grant permissions to the component.

Follow the steps below to create a custom OAuth app and obtain the connection properties in a specific OAuth authentication flow.

Create a Custom OAuth App: Desktop

Register an app in the Azure portal to obtain the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  1. After logging in to the Azure Portal with your account, click Azure Active Directory -> App Registrations.
  2. Click New Application Registration.
  3. Enter the application name.
  4. Select Web App/API in the Application Type menu.
  5. Set the Sign-On URL to http://localhost:33333, or another port number of your choice. You will set CallbackURL to the Sign-On URL.
  6. On the main page of your app you can find the OAuthClientId. You can generate a OAuthClientSecret in Settings -> Keys.
You must also add permission to use the Windows Azure Service Management API:
  1. In the section, click Required permissions -> Add -> Select an API -> Windows Azure Service Management API.
  2. In the Select Permissions step, enable the Access Azure Service Management permission.

Create a Custom OAuth App: Web Applications

Register your Azure Data Management app on the Azure portal to obtain the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  1. After logging in to the Azure Portal with your account, click Azure Active Directory -> App Registrations.
  2. Click New Application Registration.
  3. Enter the application name.

  4. Select the Web app/API application type.

    Set the Sign-on URL you want to use as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access.

  5. On the main page of your app you can find the OAuthClientId. You can generate a OAuthClientSecret in Settings -> Keys.
You must also add permission to use the Windows Azure Service Management API:
  1. In the settings section, click Required permissions -> Add -> Select an API -> Windows Azure Service Management API.
  2. In the Select Permissions step, enable the Access Azure Service Management permission.

Create a Custom OAuth App: Headless Machines

Register your Azure Data Management app on the Azure portal to obtain the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  1. After logging in to the Azure Portal with your account, click Azure Active Directory -> App Registrations.
  2. Enter the application name.

  3. Select the Web app/API application type.

    Set the Sign-on URL to http://localhost:33333, or another port number of your choice.

  4. On the main page of your app you can find the OAuthClientId. You can generate a OAuthClientSecret in Settings -> Keys.
You must also add permission to use the Windows Azure Service Management API:
  1. In the settings section, click Required permissions -> Add -> Select an API -> Windows Azure Service Management API.
  2. In the Select Permissions step, enable the Access Azure Service Management permission.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587