API Keys

List API Keys

client.Beta.Organization.APIKeys.List(ctx, query) (*Page[BetaAPIKey], error)

GET/v1/organizations/api_keys

Get API Key

client.Beta.Organization.APIKeys.Get(ctx, apiKeyID) (*BetaAPIKey, error)

GET/v1/organizations/api_keys/{api_key_id}

Update API Key

client.Beta.Organization.APIKeys.Update(ctx, apiKeyID, body) (*BetaAPIKey, error)

POST/v1/organizations/api_keys/{api_key_id}

Models

type BetaAPIKey struct{…}

type BetaAPIKeyCreatedBy struct{…}

ID string

ID of the actor that created the object.

Type BetaAPIKeyCreatedByType

Type of the actor that created the object.

One of the following:

const BetaAPIKeyCreatedByTypeServiceAccount BetaAPIKeyCreatedByType = "service_account"

const BetaAPIKeyCreatedByTypeUser BetaAPIKeyCreatedByType = "user"

type BetaAPIKeyOrganizationScope struct{…}

Type Organization

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

defaultorganization

type BetaAPIKeyServiceAccountActor struct{…}

ServiceAccountID string

ID of the Service Account the API key acts as.

Type ServiceAccountActor

Principal type. Always "service_account_actor" for a Service Account.

defaultservice_account_actor

type BetaAPIKeyUserActor struct{…}

Type UserActor

Principal type. Always "user_actor" for a User.

defaultuser_actor

UserID string

ID of the User the API key acts as.

type BetaAPIKeyWorkspaceScope struct{…}

Type Workspace

Scope type. Always "workspace": the API key belongs to one Workspace.

defaultworkspace

WorkspaceID string

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.