API Authentication
Axiad Mesh APIs require authenticated, tenant-scoped requests. This page covers the auth model at a high level; the full generated endpoint reference (delivered by a separate story) documents each operation's specifics.
Auth model
- Axiad Mesh APIs use OAuth2 for authentication.
- Requests are tenant-scoped: you only ever access data belonging to your own tenant.
- Multi-tenant isolation is enforced by the platform.
Required headers
Authenticated requests include a bearer token obtained through the standard OAuth2 flow.
Authorization: Bearer <access-token>
Accept: application/json
Authenticating the Analytics OData API
The Analytics OData feed sits behind the Mesh identity provider, which handles the OAuth challenge for you. In a BI tool, choose the Organizational account credential type and sign in with your normal Mesh credentials — you do not obtain or paste a token by hand.
The tenant parameter
On a shared Mesh host, every request must identify your tenant with a tenant
query parameter. It accepts either your organization's domain or your tenant
UUID:
https://<your-mesh-host>/api/analytics/v1/SoftwareAssets?tenant=example.com
Set the tenant parameter on the feed (base) URL so it is applied to every
request, including connection tests and scheduled refreshes. Any request that
reaches the API without tenant returns 400 Bad Request (see below), so
keep it on the feed URL rather than adding it to individual queries.
If your organization has a dedicated Mesh subdomain, the tenant is resolved from the hostname and the parameter is unnecessary.
What the API returns when authentication is incomplete
| Response | Meaning |
|---|---|
401 Unauthorized | No authenticated session. Sign in through the Mesh identity provider — in a BI tool, re-check that the credential type is Organizational account. |
400 Bad Request | The tenant parameter is missing or malformed. |
403 Forbidden | The tenant parameter names a different tenant than the signed-in session. |
Every response is scoped to your own tenant. There is no way to widen a query beyond it.
Where to go next
- The API Reference section (generated from published OpenAPI specs) documents endpoints, schemas, and per-service details.
- See the Admin Guide for tenant and access configuration.