Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.poolside.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Use service account API keys for automation and other non-interactive workflows, such as CI pipelines, where browser-based sign-in is not practical. When you create a service account API key, Poolside creates a service account and adds it to the team you select. That service account:
  • Inherits the team’s permissions through role-based access control
  • Is not tied to the lifecycle of an individual user account
  • Behaves like any other identity for auditing
For a comparison of developer API keys and service account API keys, see Authentication. Service account API keys do not currently expire automatically. To remove access, delete the service account and its API key.

​
Create a service account API key

Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Security > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/key-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=471edb89504a9e747e97caa541181d47 API Keys.
  2. Click New API Key.
  3. Select the team whose permissions the service account should inherit.
  4. Enter a name for the API key.
  5. Click Create.
  6. Copy the generated key and store it securely.
The full API key value is shown only once. Store it securely.
API keys typically have a ps-xxxxx format.

​
Manage service account API keys

From the Security > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/key-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=471edb89504a9e747e97caa541181d47 API Keys page in the Poolside Console, administrators can:
  • View all service account API keys in the organization
  • Create new service account API keys
  • Search for API keys
  • Delete service accounts and their API keys
To delete a service account and its API key, click the delete icon for the service account, and then click Delete Service Account. This action cannot be undone.