API Authentication

In order to establish communication with the Nexus API you will require an authentication token. To receive such a token, you will have to create and use a Service Account user. For detailed setup instructions to receive an authentication token, refer to the Start developing - API Authentication section.

A Service Account is a special type of account created in the Nexus Identity portal under the accounts tab, designed for automated or programmatic access to Nexus APIs. Each Service Account can have multiple API keys, each with its own configurable expiration date. API keys can be revoked at any time to immediately remove access if needed. Service Accounts support granular access control through assignable roles and permissions, just like User Accounts. This enables you to precisely restrict which Nexus APIs a Service Account can access, such as limiting it to read-only operations or granting access to specific API endpoints. Service Accounts are ideal for backend services, integrations, and automation scenarios where secure, auditable, and controlled API access is required.

Two default roles are provided and preconfigured for ease of assignment to Service Accounts. One role grants full access to the Nexus API solution, while the other provides read-only access. If more control is required, custom roles can be created to tailor permissions and assign only the specific access needed for a given service account. For more information on a service account or the default roles available to assign to it, refer to the Identity Account section.