Skip to main content

​
Overview

Use organization API keys to give shared access within your organization instead of supporting individual user workflows. Organization API keys belong to service accounts, not individual user accounts, and remain active even if you remove the user who created them. When you create an organization API key, Poolside creates a service account and adds it to the team you select. The key then uses that team’s permissions and quotas, and Poolside tracks its usage under that team.

​
Create an API key

Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Settings > https://mintcdn.com/poolside/fyUKzbRkxqIwtXwu/images/icons/key-icon.svg?fit=max&auto=format&n=fyUKzbRkxqIwtXwu&q=85&s=b4dba51791f4df5d4e8732dbfe2459c9 API Keys.
  2. Click New API Key.
  3. Select the team that the service account for this key belongs to.
  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 organization API keys

From the API Keys page in the Poolside Console, administrators can:
  • View all service account API keys in the organization
  • See metadata such as creator details
  • Search for API keys
  • Revoke API keys
Revoking a key disables its access.