Skip to main content

​
API Key Authentication

All Omni API requests require authentication via the x-api-key header. 
curl -X GET "http://client-omni-api.argosidentity.com/v1/projects/{projectId}" \
  -H "x-api-key: your-api-key-here"

​
How to Get Your API Key

1

Log in to the Omni Dashboard

Access the Omni dashboard at your designated URL.
2

Navigate to Project Settings

Select your project and go to the settings page.
3

Copy Your API Key

Your API key is displayed in the project settings. Copy and store it securely.
Never expose your API key in client-side code, public repositories, or logs. Store it securely using environment variables or a secret manager.

​
Base URL

All API requests are made to the following base URL: 
http://client-omni-api.argosidentity.com/v1
If you control network access with a firewall or proxy, allow outbound HTTP to client-omni-api.argosidentity.com (port 80) for Omni API calls. Allow port 443 as well if you use HTTPS.

​
Request Headers

Every request must include:
HeaderValueRequired
x-api-keyYour API key (UUID format)Yes
Content-Typeapplication/json or multipart/form-dataYes (for POST/PATCH)

​
Error Responses

If authentication fails, the API returns: 
{
  "error": {
    "code": "UNAUTHORIZED",
    "status": 401,
    "message": "Invalid or missing API key"
  }
}