Microsoft Azure OpenAI authentication

Connect UiPath to Microsoft Azure OpenAI using OAuth 2.0 Client Credentials or an API key, by providing your Azure OpenAI endpoint URL, Tenant ID, and related credentials.

Prerequisites

This connector supports two authentication methods: OAuth 2.0 Client credentials and API key.

To create a connection, you need the following credentials:

• OAuth 2.0 Client credentials:
  • Url - The base URL of your Azure OpenAI endpoint, including https://.
  • Tenant ID - The Azure Active Directory (AAD) tenant ID associated with your Microsoft Azure OpenAI account. Tenant ID for single-tenant apps is found in the Overview section. Use common for personal, enterprise, or multi-tenant accounts.
  • Client ID - The client ID of the registered application in AAD. You can find it in the Overview section of your Microsoft Azure application registration.
  • Client Secret - The client secret of the registered application in AAD. You can create a new client secret in the Certificates & secrets section of your Microsoft Azure application registration.
  • API version - This represents the REST API version used to interact with the Azure OpenAI service. You can input any API version you want to connect to.
• API key:
  • API Key - The API key associated with your Microsoft Azure OpenAI account.
  • Url - The base URL of your Azure OpenAI endpoint, including https://.
  • API version - This represents the REST API version used to interact with the Azure OpenAI service. You can input any API version you want to connect to.

Retrieving the Azure OpenAI endpoint URL

Your endpoint has the form https://<your-resource-name>.openai.azure.com, where <your-resource-name> is your Azure resource name. Enter the entire address in the Url field, including the https:// prefix.

Note:

For a Private (Relay) connection, leave Url empty. The connector builds the request URL from the Relay configuration instead.

You can retrieve the resource name only from Azure. If you deployed your own OpenAI service, the instance name you chose during the deployment phase is the resource name. To learn more, refer to the Create and deploy an Azure OpenAI Service resource guide in the Microsoft official documentation.

Add the Microsoft Azure OpenAI connection

To create a connection to your Microsoft Azure OpenAI instance, you need to perform the following steps:

1. Select Orchestrator from the product launcher.

2. Select a folder, and then navigate to the Connections tab.

3. Select Add connection.

4. To open the connection creation page, select the connector from the list. You can use the search bar to find the connector.

5. Select the authentication type: OAuth 2.0 Client credentials or API key.

6. Enter the required credentials and select Connect.

   Where available, select the menu next to a field and choose Use credential asset or Use Orchestrator asset to reference an Orchestrator asset instead of entering the value directly. For more information, see Use credential assets for connections.