A Comprehensive Guide to Setting Up OAuth 2.0 Connections in Azure APIM
Table of Contents#
Overview#
This comprehensive guide will walk you through the process of creating a new connection in the Ejento AI Credential Manager within Azure API Management (APIM).The Credential Manager is configured to use the OAuth 2.0 Client Credentials flow, which provides secure, token-based authentication for API access.
Prerequisites#
Before you begin, ensure you have the following requirements met:| Requirement | Description |
|---|
| Azure Portal Access | Active account with access to your APIM instance |
| Client ID | Provided by Ejento AI team |
| Client Secret | Provided by Ejento AI team |
| Appropriate Permissions | Permissions to manage connections in APIM |
Important: Keep your Client ID and Client Secret secure. Do not share these credentials with unauthorized users.
Step-by-Step Guide#
Follow these detailed steps to successfully create your connection:Step 1: Access Azure Portal#
2.
Sign in with your Azure credentials
3.
Locate and select your API Management (APIM) instance from the dashboard
Step 2: Navigate to Credential Manager#
In the left-hand navigation menu, follow this path:APIs → Credential Manager
🔍 Click here if you can't find the Credential Manager
If you don't see the Credential Manager option:Ensure you have the necessary permissions
Verify that your APIM instance supports this feature
Try refreshing the Azure Portal page
Step 3: Select OAuth 2.0 Credential Manager#
1.
Look for the credential manager in the list
2.
Identify the one where the identity provider is listed as "OAuth 2.0"
3.
Click on it to open the credential manager
Note: There may be multiple credential managers. Ensure you select the one specifically configured for OAuth 2.0.
Step 4: Add a New Connection#
Click on the "+ Add" button to initiate the creation of a new connection.
Step 5: Enter Connection Details#
Carefully fill in the following information in the connection form:| Field | Value | Example |
|---|
| Name | A descriptive name for your connection | ejento-connection or ejento-prod-connection |
| Client ID | The Client ID provided by Ejento AI team | abc123-def456-ghi789 |
| Client Secret | The Client Secret provided by Ejento AI team | ****************** |
💡 Best Practice: Use a naming convention that clearly identifies the purpose and environment (e.g., ejento-dev-connection, ejento-prod-connection).
Step 6: Save the Connection#
1.
Review all entered information for accuracy
2.
Click the "Save" button to create the connection
Warning: Double-check your Client ID and Client Secret before saving. Incorrect credentials will prevent successful connection.
Step 7: Verify APIM Resource#
1.
The APIM resource should automatically appear under the members section
2.
Verify that the resource name matches your APIM instance
Step 8: Complete the Setup#
Click the "Complete" button to finalize the connection configuration.
Step 9: Confirm Connection Status#
Verify the successful creation of your connection:1.
Check the connection status indicator
2.
Ensure it displays as "Connected" with a green indicator
Support#
If you encounter any issues or need assistance during the setup process, please contact the Ejento AI Support Team at developer.support@ejento.ai
Next Steps: You can now proceed to configure your APIs to use this connection for authentication.
