Skip to content
Primary navigation

Admin API Keys

List all organization and project API keys.
admin.organization.admin_api_keys.list(AdminAPIKeyListParams**kwargs) -> SyncCursorPage[AdminAPIKey]
GET/organization/admin_api_keys
Create admin API key
admin.organization.admin_api_keys.create(AdminAPIKeyCreateParams**kwargs) -> AdminAPIKeyCreateResponse
POST/organization/admin_api_keys
Retrieve admin API key
admin.organization.admin_api_keys.retrieve(strkey_id) -> AdminAPIKey
GET/organization/admin_api_keys/{key_id}
Delete admin API key
admin.organization.admin_api_keys.delete(strkey_id) -> AdminAPIKeyDeleteResponse
DELETE/organization/admin_api_keys/{key_id}
ModelsExpand Collapse
class AdminAPIKey:

Represents an individual Admin API key in an org.

id: str

The identifier, which can be referenced in API endpoints

created_at: int

The Unix timestamp (in seconds) of when the API key was created

formatunixtime
object: Literal["organization.admin_api_key"]

The object type, which is always organization.admin_api_key

owner: Owner
id: Optional[str]

The identifier, which can be referenced in API endpoints

created_at: Optional[int]

The Unix timestamp (in seconds) of when the user was created

formatunixtime
name: Optional[str]

The name of the user

object: Optional[str]

The object type, which is always organization.user

role: Optional[str]

Always owner

type: Optional[str]

Always user

redacted_value: str

The redacted value of the API key

last_used_at: Optional[int]

The Unix timestamp (in seconds) of when the API key was last used

formatunixtime
name: Optional[str]

The name of the API key

class AdminAPIKeyCreateResponse:

Represents an individual Admin API key in an org.

value: str

The value of the API key. Only shown on create.

class AdminAPIKeyDeleteResponse:
id: str
deleted: bool
object: Literal["organization.admin_api_key.deleted"]