Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
There are two ways to authenticate and gain access to the Microsoft Web IQ APIs. Use an API key for the quickest start and Microsoft Entra ID for production workloads.
API key
Create an API key in the Microsoft Web IQ portal to authenticate with Microsoft Web IQ APIs. Pass it in the x-apikey header on every request:
x-apikey: <YOUR_API_KEY>
Warning
API keys grant full access to your account. Store them in a secret manager, not in client-side code or source control.
Microsoft Entra ID
Use Microsoft Entra ID OAuth 2.0 Client Credentials (app-only token) for authenticating with the Microsoft Web IQ API.
Note
Microsoft Entra ID is the identity platform. An app registration has an Application (client) ID, which identifies the application in your tenant and is the value you bind to your Web IQ account. At runtime, your app exchanges its credentials for a Microsoft Entra access token to send with each API request.
Prerequisites
Set up a tenant: To register your app, an Azure tenant is required. An Azure subscription isn't required, but if your organization already has one or more Azure subscriptions or a Microsoft 365 organization, then you already have an Azure tenant. Otherwise, provision a new tenant.
Create an app registration: An app registration establishes a trust relationship between your application and the Microsoft identity platform, enabling your app to authenticate and access resources securely.
When you register your app, a client ID, object ID, and directory ID are created. To create credentials for your app registration, see Register an application with the Microsoft identity platform.
Entra ID setup steps
App registration - Use an existing Microsoft Entra ID app registration or create one. Record its Application (client) ID. In the Azure portal, find it under Microsoft Entra ID > App registrations > your app > Overview.
Bind your app registration - Go to Profile Management, select the Application (Client) IDs tab, and then select Bind Application (Client) ID. Enter your application (client) ID. Profile updates can take up to one minute to synchronize.
Note
If the Application (Client) IDs tab isn't available, Microsoft Entra ID authentication might not be enabled for your trial. Contact your Microsoft representative to request dedicated access.
Acquire a token - Use the client credentials grant with your preferred Microsoft Authentication Library (MSAL):
- Authority:
https://login.microsoftonline.com/{your-tenant-id} - Scope:
https://api.microsoft.ai/.default
- Authority:
Then pass the access token on every Web IQ request:
Authorization: Bearer <access-token>
Request headers
| Header | Value | Description |
|---|---|---|
x-apikey or Authorization |
<your-api-key> or Bearer <access-token> |
Your API key or Microsoft Entra ID access token for authentication |
Content-Type |
application/json |
Request body format |
Next steps
- Make your first call in the quickstart.
- Explore the REST API reference.
Support and feedback
Send technical issues or feedback to Web IQ Support.