Skip to main content

Onboard an API with Azure API Gateway


Prerequisites​

Create an app registration in Azure Active Directory (AAD)​

  • Log in to Azure Portal.

  • Follow the steps below to obtain the Client ID and Tenant ID.

  • Click on New registration in App registrations

    New registration in App registrations

  • Enter the name of the application, choose supported account types, and (optionally) set a Redirect URI, then click Register

    App registration details

  • Copy the Application (client) ID and Directory (tenant) ID.

    Application (client) ID and Directory (tenant) ID

  • Follow the steps below to obtain the Client secret, i.e., the Key.

  • Visit Certificates & secrets, click New client secret, and copy the generated values

    New client secret

    Copy the generated client secret values

  • To get the Subscription Id, navigate to Subscriptions and copy the Subscription ID

    Subscription ID in Subscriptions

  • Assign the API Management Service Reader role to the App Registration on the APIM resource to allow read-only access for fetching OpenAPI specifications.

    • Select Add role assignment in Access control (IAM)

    Add role assignment in Access control (IAM)

    • Select the role 'API Management Service Reader'

    Select the API Management Service Reader role

    • Assign the role to the created App Registration (Service Principal) and click Next

    Assign the role to the app registration

    • Click Review&Assign Review and assign the role

Azure integration with the APIsec product​

Start adding a new application​


Select Azure API Gateway​

  • Choose the Azure API Gateway option. Choose the Azure API Gateway

  • If existing connections are available, they will be displayed in the Connections list. To create a new connection, click New Connection.

  • If no connections exist, a connection form is displayed, allowing you to enter the required details and create a connection.

    New Connection option


Enter application details​

  • Fill in the form with Name, Key, Subscription Id, and Tenant Id Azure connection form

  • Click Test Connection Test Connection button

  • Test Connection Success

    Connection test success message

  • Click Create Connection

    Create Connection button

  • Select the Resource Group and API Management Service, then select the required API

    Select the Resource Group, API Management Service, and API

  • Click Continue

    Continue button

  • Click Onboard

    Onboard button

  • Azure Application Dashboard

    Azure application dashboard


Auto-Onboard​

The Auto-Onboard feature streamlines API onboarding by automatically detecting and registering unregistered APIs from Azure Gateway. This ensures that all APIs, including newly published ones, are consistently onboarded and tested for vulnerabilities with minimal manual effort.

Enable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Azure

    Onboard Applications for Azure

  • Enable Auto-Onboard of any existing Azure Gateway connection.

    Auto-Onboard toggle

  • Fill in the Azure AutoOnboard Details and click Save Schedule

    • Frequency – How often the onboarding should occur. By default it is weekly.
    • Day of the Week – Select the specific day for onboarding.
    • Hour – The exact time (in hours and minutes) when the onboarding should start.
    • Timezone – The timezone in which the schedule should be applied
    • Resource Groups - Select Resource Group
    • Services - Select Service

    Azure AutoOnboard details and Save Schedule button

    • Successfully saved auto-onboard details

    Auto-onboard saved confirmation

Update Schedule​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Azure

    Onboard Applications for Azure

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • Update the details and click Update Schedule Update Schedule button

Disable Auto-Onboard​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Azure

    Onboard Applications for Azure

  • Click Auto-Onboard enabled toggle

    Auto-Onboard enabled toggle

  • In Edit Azure AutoOnboard Details, disable the Enable Automatic API Onboarding.

    Disable automatic API onboarding

  • Click Yes to confirm

    Confirmation dialog

  • Auto-Onboard details deleted.

    Auto-Onboard details deleted message

Edit Azure connection​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Azure

    Onboard Applications for Azure

  • A list of existing Azure connections is displayed.

    Azure connections list

  • Select the Pencil icon next to the connection you want to edit.

    Pencil icon next to a connection

  • Update the required details and click Test Connection

    Test Connection button

  • Once the connection test succeeds, click Update Connection

    Update Connection button

  • The updated connection is now displayed in the connections list.

    Azure connections list

Delete Azure connection​

  • Open your browser and visit: https://<your-tenant>.apisecapps.com

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Azure

    Onboard Applications for Azure

  • A list of existing Azure connections is displayed.

    Azure connections list

  • Select the Delete icon next to the connection you want to delete.

    Delete icon next to a connection

  • Click Delete to confirm

    Delete confirmation dialog

  • The deleted connection is no longer displayed in the connections list.

    Connections list after deletion