Azure Integration Setup

These instructions ensure Apiboost maintains its connection to Azure APIM for managing API products, subscriptions, and user metadata.

To maintain the Apiboost-Azure connection, follow these steps:

1. Retrieve your Azure Tenant ID

2. Register a new Azure App

3. Generate system credentials

4. Configure RBAC for API Management access

5. Store credentials in Apiboost

You must have access to a system level admin in Azure Portal and Entra to be able to complete this guide.

Retrieving your Tenant ID

This section will cover how to retrieve your Tenant ID from Azure Portal.

If you have multiple tenants, ensure that you select the Tenant that is connected to the Resource Group that your API Management is registered under.

1. Log in to https://portal.azure.com

2. In the top navigation, click the hamburger menu → click Microsoft Entra ID.

3. In the Overview section, find your Tenant ID and copy it.

4. Store the Tenant ID in a separate document.

Register a new Azure App

1. Navigate to Microsoft Entra Admin UI.

2. In the lefthand column, expand Manage and click App Registrations.

3. In the main content section, find the tabbed navigation and click + New Application.

4. Provide all information needed to create the app:

   1. Name: A user facing name that will be visible if using the App for SSO Authentication in Apiboost.

   2. Supported Account Types: Determines who has access to this application. For most instances, a Single Tenant option will work. However, for more advanced Azure setups with multiple tenants & user directories, multi-tenant could be selected. For our guide, we will select single tenant.

   3. Redirect URI: Leave this blank unless configuring for SSO. If you would like to allow users to authenticate with their Entra Account in Apiboost, please follow this tutorial to setup. For now, we will leave this blank.

5. Click Register.

6. Once the registration process has completed, store the Application (client) ID with your Tenant ID.

7. Now that the new App is created, we will go ahead and configure permissions to use the Azure Management APIs.

8. In left hand menu, click API Permissions + Add a Permission

9. Select Azure Service Management and check user_impersation

10. Click Add Permissions to save.

Generate System Credentials

For accessing Azure API Management entities via Microsoft ARM APIs, we must generate system level credentials for Apiboost to use to request authorization tokens as. Roles and permissions will be configured on the API Management service itself so these credentials are simply to inform Azure that we are who say we are.

1. While viewing the overview of your Azure App, expand the Manage menu in left hand navigation.

2. Click Certificates & Secrets menu item.

3. In the main content area, click Client Secrets and + New client secret

4. Enter a description of your choice and an expiration date.

The length of expiration is dependent on the needs of your organization. If you do not have any business rules or requirements from security teams, we recommend 12 months expiration.

5. Click Add to save the credentials. Once the process completes, you will be able to copy your Secret Value. The secret value will be hidden after you leave this screen. Copy and store it securely.

Assign Service Admin Role to App in APIM

1. Navigate to https://portal.azure.com

2. Navigate to your APIM instance.

3. On the overview, click Access control (IAM) in the left hand navigation.

4. Click Add → Add role assignment

5. Under Role tab, click API Management Service Contributor to select.

6. Under Members tab, by default User, group, or service principal is selected. If not, select it.

7. Click + Select Members

8. Search for the name of your App and click to select.

9. Click Review & Assign to save.

10. Under Role Assignments tab on the IAM overview, you will see your service principal listed under API Management Service Contributor.

Congratulations! Everything has been configured in Azure to connect Apiboost to your APIM instance. Now, let’s add the configurations that were copied during the steps above into Apiboost to finalize the connection.

Subscription ID, Resource Group ID & Service Name

In order to make requests to the correct instance of your Azure API Management resource, we will need to retrieve and store the Azure Subscription ID, Resource Group ID and Service Name. These values can be found by performing these steps:

1. Navigate to your APIM instance Overview section.

2. Click JSON View in the top right hand corner.

3. With the JSON View expanded, you can copy the Resource ID

4. Optionally choose an API Version that you would like to use. Some administrators enforce API Version, however Apiboost will use the latest API Version available unless otherwise specified in the Admin UI.