Apidog supports integration with Azure Key Vault using Authorization Code (With PKCE) or Client Credentials. Administrators can choose the authentication method from the Grant Type dropdown when configuring an Azure Key Vault provider.Authorization Code (With PKCE)#
Select Authorization Code (With PKCE) (the default) as the Grant Type to authenticate through an interactive sign-in. To configure your OIDC application, follow these steps:1.
Open your Microsoft Entra ID management portal in a browser.
2.
Go to App registrations and select New registration.
3.
Enter the name of the application (e.g., "Vault Integration") and click Register.
4.
On the application's Overview page, copy the Application (client) ID and paste it into the Client ID field in Apidog.
6.
Copy the OAuth 2.0 authorization endpoint (v2) and paste it into the Auth URL field in Apidog.
7.
Copy the OAuth 2.0 token endpoint (v2) and paste it into the Access Token URL field in Apidog.
8.
Go to the application's Authentication page, click Add a platform, then select Single-page application.
9.
Copy the Callback URL from Apidog and paste it into the Redirect URIs field.
10.
Return to the home page of the Microsoft Entra ID management portal, go to Enterprise Applications, and select the application you just registered.
11.
On the Users and groups page, add users or groups who require access to the key vault.
Client Credentials#
Select Client Credentials as the Grant Type to authenticate using an application's client ID and client secret, without an interactive user sign-in.1.
In Microsoft Entra ID, register an application or select an existing application under App registrations.
2.
On the application's Overview page, copy the Application (client) ID into Client ID in Apidog.
3.
Click Endpoints and copy the OAuth 2.0 token endpoint (v2) into Access Token URL in Apidog.
4.
Go to Certificates & secrets, create a client secret, and copy its Value into Client Secret in Apidog. Use the secret value, not the secret ID.
5.
Ensure the application's service principal has permission to list and read secrets in the target Azure Key Vault.
6.
Enter the target vault's name in Key Vault Name in Apidog.
The required fields for this grant type are Access Token URL, Client ID, Client Secret, and Key Vault Name. Auth URL and Callback URL are hidden and are not required. The single-page application, redirect URI, and user sign-in configuration described above applies only to Authorization Code (With PKCE).Test Connection#
1.
Enter the Key Vault Name and complete the fields for the selected Grant Type in Apidog.
2.
Authorization Code (With PKCE): An OAuth 2.0 login window will appear. Complete the sign-in.
Client Credentials: Apidog uses the configured client credentials to obtain an access token and test access to the vault. No login window opens.
3.
If the connection test succeeds, "Succeeded" will be displayed.
The following example shows testing with Authorization Code (With PKCE):Link Secrets#
Assume there is a secret named foo in Azure Key Vault:To link this secret in Apidog:1.
Enter the metadata as shown below.
2.
Click the Fetch Secrets button.
3.
Click the eye icon on the right to view the retrieved secret value.
Modified at 2026-11-16 09:17:36