Skip to main content

​
API key authentication

Every Omni API request authenticates with the x-api-key header. Keys are issued per project, and a key can only work with the resources inside its own project.

​
Getting an API key

1

Select a project

Sign in to the Omni dashboard and open a project from the list. An API key is issued together with the project when you create it.
2

Project Management → API Key tab

Open the API Key tab under Project Management in the sidebar. The key is masked; reveal it with the eye icon or use the copy button.
3

Store it safely

Keep it in an environment variable or a secret manager. Never expose it in client code, a public repository, or logs.
If you suspect the key has been exposed, regenerate it on the same tab. The old key is invalidated immediately, and API calls receive 401 until you finish rolling out the new one. The procedure is in API key.

​
Base URL and headers

Behind a firewall or proxy, allow outbound HTTPS (443) to client-omni-api.argosidentity.com.

​
Authentication errors

For the error body format, see the API overview.