Service accounts¶

Service accounts are specialized accounts designed for automated interactions with your Comet installation. They are an ideal solution for scenarios where using a personal user API Key is impractical, such as in webhook automation, production monitoring, or automated data retrieval.

Only Organization Admins can create and manage service accounts.

Permissions and Security¶

Service accounts inherit the same permissions as an Organization Admin, granting them full read and write access across all workspaces within the organization. Due to the high level of access, it is critical to handle service account API Keys with care, ensuring they are used only in secure environments.

Managing Service Accounts¶

Viewing Service Accounts¶

All service accounts can be viewed in the Admin Dashboard, where you can also search for accounts by name.

Comet Admin Dashboard - Service Accounts tab — The Service Accounts tab in the Comet Admin Dashboard

Creating a Service Account¶

To create a new service account, navigate to the Admin Dashboard and click "Create Service Account."

Enter a name for the account and optionally set a default workspace. The system will automatically generate an API Key for the new service account, which can be used in the same way as a personal user API Key.

Comet Admin Dashboard - Service Accounts creation — Service Account creation flow in the Admin Dashboard

Note

Service account names are automatically prefixed with "sa-" to distinguish them from user accounts.

Warning

If a default workspace is not set, you must specify a workspace when logging new experiments. Failing to do so will result in an error.

Regenerating an API Key¶

If you need to regenerate a service account's API Key, click the ⋮ icon next to the account in the list and select "Regenerate API Key." Keep in mind that service account API Keys have a high level of access, so they should be stored and used securely.

Deleting a Service Account¶

To delete a service account, click the ⋮ icon next to the account in the list and select "Delete." Deleting a service account does not affect any data or experiments previously logged using that account's API Key. All existing data remains intact.

Limits and Best Practices¶

Availability: Service Accounts are only available for Enterprise plan users.
API Key Sharing: A single service account API Key can be used by multiple clients. However, excessive data logging with a single API Key may lead to throttling. To avoid this, we recommend creating distinct service accounts for different purposes.

Programmatic Management¶

It is also possible to manage Service Accounts using our Rest API:

Sep. 12, 2024