Skip to content

Service accounts#

To automate and enhance your workflow, you can create service accounts in your team workspace. This way you can have multiple API tokens or non-user tokens in your setup.

Service accounts are a special type of non-human privileged account. You can use them for automated processes, such as training pipelines and report generation, instead of maintaining user accounts for this purpose.

Creating a service account

  1. In the top-left of the Neptune app, click your workspace name to access your workspace view.
  2. Click the Service accounts tab to get started.

Good to know#

The service account is always tied to a particular workspace, where it can act like a user account depending on the project permissions assigned to it.

  • You can have up to 50 service accounts per workspace.

  • The name of a service account ends with @workspace-name.

    Example: If you create a service account "report-generation" in a workspace called "ml-team", the service account name will be report-generation@ml-team.

  • A service account can't access a project without being specifically assigned to it, even if the project visibility is set to "workspace".

  • You can only deactivate a service account, not delete it completely.

    Warning

    If the service account is reactivated after being deactivated, the API token is refreshed.

Service account can Service account cannot
✅ Create runs and other objects ❌ Have a personal workspace
✅ Be the owner of created projects and objects ❌ Be a member of multiple workspaces
✅ Have any project role ❌ Have the workspace admin role
✅ Function and use API calls according to permissions ❌ Delete projects1

Who can manage service accounts#

Workspace admins and project owners can do the following:

  • Access service account settings
  • Add a service account to a project
  • Remove a service account from a project
  • Change the service account role within a project

Only workspace admins can access and manage the Neptune API tokens of service accounts.

Related

You can also managage service accounts through the management API. Most of the management operations can be performed by service accounts, as well.

  1. Only workspace admins can delete projects, and a service account can't be workspace admin. ↩