Claude Platform Docs

Beta

Models
type AnthropicBeta interface{…}
One of the following:
type BetaAPIError struct{…}
Message string
defaultInternal server error
Type APIError
defaultapi_error
type BetaAuthenticationError struct{…}
Message string
defaultAuthentication error
Type AuthenticationError
defaultauthentication_error
type BetaBillingError struct{…}
Message string
defaultBilling error
Type BillingError
defaultbilling_error
type BetaCurrency string
type BetaErrorUnion interface{…}
One of the following:
type BetaErrorResponse struct{…}
Error BetaErrorUnion
One of the following:
RequestID string
Type Error
defaulterror
type BetaGatewayTimeoutError struct{…}
Message string
defaultRequest timeout
Type TimeoutError
defaulttimeout_error
type BetaInvalidRequestError struct{…}
Message string
defaultInvalid request
Type InvalidRequestError
defaultinvalid_request_error
type BetaMonetaryAmount struct{…}

A monetary amount in a specific currency.

Amount string

Amount in minor units of the currency, as an integer decimal string with no leading zeros: "2500" is $25.00 and "50" is fifty cents. A string rather than a number so no float rounding is ever applied.

Currency BetaCurrency

Uppercase ISO-4217 currency code. USD is the only currency currently supported; the accepted set is closed and grows only when a new currency is priced.

type BetaNotFoundError struct{…}
Message string
defaultNot found
Type NotFoundError
defaultnot_found_error
type BetaOverloadedError struct{…}
Message string
defaultOverloaded
Type OverloadedError
defaultoverloaded_error
type BetaPermissionError struct{…}
Message string
defaultPermission denied
Type PermissionError
defaultpermission_error
type BetaRateLimitError struct{…}
Message string
defaultRate limited
Type RateLimitError
defaultrate_limit_error

BetaModels

List Models
client.Beta.Models.List(ctx, params) (*Page[BetaModelInfo], error)
GET/v1/models
Get a Model
client.Beta.Models.Get(ctx, modelID, query) (*BetaModelInfo, error)
GET/v1/models/{model_id}

BetaMessages

Create a Message
client.Beta.Messages.New(ctx, params) (*BetaMessage, error)
POST/v1/messages
Count tokens in a Message
client.Beta.Messages.CountTokens(ctx, params) (*BetaMessageTokensCount, error)
POST/v1/messages/count_tokens

BetaMessagesBatches

Create a Message Batch
client.Beta.Messages.Batches.New(ctx, params) (*BetaMessageBatch, error)
POST/v1/messages/batches
Retrieve a Message Batch
client.Beta.Messages.Batches.Get(ctx, messageBatchID, query) (*BetaMessageBatch, error)
GET/v1/messages/batches/{message_batch_id}
List Message Batches
client.Beta.Messages.Batches.List(ctx, params) (*Page[BetaMessageBatch], error)
GET/v1/messages/batches
Cancel a Message Batch
client.Beta.Messages.Batches.Cancel(ctx, messageBatchID, body) (*BetaMessageBatch, error)
POST/v1/messages/batches/{message_batch_id}/cancel
Delete a Message Batch
client.Beta.Messages.Batches.Delete(ctx, messageBatchID, body) (*BetaDeletedMessageBatch, error)
DELETE/v1/messages/batches/{message_batch_id}
Retrieve Message Batch results
client.Beta.Messages.Batches.Results(ctx, messageBatchID, query) (*BetaMessageBatchIndividualResponse, error)
GET/v1/messages/batches/{message_batch_id}/results

BetaAgents

Create Agent
client.Beta.Agents.New(ctx, params) (*BetaManagedAgentsAgent, error)
POST/v1/agents
List Agents
client.Beta.Agents.List(ctx, params) (*PageCursor[BetaManagedAgentsAgent], error)
GET/v1/agents
Get Agent
client.Beta.Agents.Get(ctx, agentID, params) (*BetaManagedAgentsAgent, error)
GET/v1/agents/{agent_id}
Update Agent
client.Beta.Agents.Update(ctx, agentID, params) (*BetaManagedAgentsAgent, error)
POST/v1/agents/{agent_id}
Archive Agent
client.Beta.Agents.Archive(ctx, agentID, body) (*BetaManagedAgentsAgent, error)
POST/v1/agents/{agent_id}/archive

BetaAgentsVersions

List Agent Versions
client.Beta.Agents.Versions.List(ctx, agentID, params) (*PageCursor[BetaManagedAgentsAgent], error)
GET/v1/agents/{agent_id}/versions

BetaEnvironments

Create Environment
client.Beta.Environments.New(ctx, params) (*BetaEnvironment, error)
POST/v1/environments
List Environments
client.Beta.Environments.List(ctx, params) (*PageCursor[BetaEnvironment], error)
GET/v1/environments
Get Environment
client.Beta.Environments.Get(ctx, environmentID, query) (*BetaEnvironment, error)
GET/v1/environments/{environment_id}
Update Environment
client.Beta.Environments.Update(ctx, environmentID, params) (*BetaEnvironment, error)
POST/v1/environments/{environment_id}
Delete Environment
client.Beta.Environments.Delete(ctx, environmentID, body) (*BetaEnvironmentDeleteResponse, error)
DELETE/v1/environments/{environment_id}
Archive Environment
client.Beta.Environments.Archive(ctx, environmentID, body) (*BetaEnvironment, error)
POST/v1/environments/{environment_id}/archive

BetaEnvironmentsWork

Get Work Item
client.Beta.Environments.Work.Get(ctx, workID, params) (*BetaSelfHostedWork, error)
GET/v1/environments/{environment_id}/work/{work_id}
Poll for Work
client.Beta.Environments.Work.Poll(ctx, environmentID, params) (*BetaSelfHostedWork, error)
GET/v1/environments/{environment_id}/work/poll
Acknowledge Work
client.Beta.Environments.Work.Ack(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}/ack
Record Heartbeat
client.Beta.Environments.Work.Heartbeat(ctx, workID, params) (*BetaSelfHostedWorkHeartbeatResponse, error)
POST/v1/environments/{environment_id}/work/{work_id}/heartbeat
Stop Work
client.Beta.Environments.Work.Stop(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}/stop
List Work Items
client.Beta.Environments.Work.List(ctx, environmentID, params) (*PageCursor[BetaSelfHostedWork], error)
GET/v1/environments/{environment_id}/work
Update Work Item
client.Beta.Environments.Work.Update(ctx, workID, params) (*BetaSelfHostedWork, error)
POST/v1/environments/{environment_id}/work/{work_id}
Get Queue Statistics
client.Beta.Environments.Work.Stats(ctx, environmentID, query) (*BetaSelfHostedWorkQueueStats, error)
GET/v1/environments/{environment_id}/work/stats

BetaSessions

Create Session
client.Beta.Sessions.New(ctx, params) (*BetaManagedAgentsSession, error)
POST/v1/sessions
List Sessions
client.Beta.Sessions.List(ctx, params) (*BidirectionalPageCursor[BetaManagedAgentsSession], error)
GET/v1/sessions
Get Session
client.Beta.Sessions.Get(ctx, sessionID, query) (*BetaManagedAgentsSession, error)
GET/v1/sessions/{session_id}
Update Session
client.Beta.Sessions.Update(ctx, sessionID, params) (*BetaManagedAgentsSession, error)
POST/v1/sessions/{session_id}
Delete Session
client.Beta.Sessions.Delete(ctx, sessionID, body) (*BetaManagedAgentsDeletedSession, error)
DELETE/v1/sessions/{session_id}
Archive Session
client.Beta.Sessions.Archive(ctx, sessionID, body) (*BetaManagedAgentsSession, error)
POST/v1/sessions/{session_id}/archive

BetaSessionsEvents

List Events
client.Beta.Sessions.Events.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionEventUnion], error)
GET/v1/sessions/{session_id}/events
Send Events
client.Beta.Sessions.Events.Send(ctx, sessionID, params) (*BetaManagedAgentsSendSessionEvents, error)
POST/v1/sessions/{session_id}/events
Stream Events
client.Beta.Sessions.Events.Stream(ctx, sessionID, params) (*BetaManagedAgentsStreamSessionEventsUnion, error)
GET/v1/sessions/{session_id}/events/stream

BetaSessionsResources

Add Session Resource
client.Beta.Sessions.Resources.Add(ctx, sessionID, params) (*BetaManagedAgentsFileResource, error)
POST/v1/sessions/{session_id}/resources
List Session Resources
client.Beta.Sessions.Resources.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionResourceUnion], error)
GET/v1/sessions/{session_id}/resources
Get Session Resource
client.Beta.Sessions.Resources.Get(ctx, resourceID, params) (*BetaSessionResourceGetResponseUnion, error)
GET/v1/sessions/{session_id}/resources/{resource_id}
Update Session Resource
client.Beta.Sessions.Resources.Update(ctx, resourceID, params) (*BetaSessionResourceUpdateResponseUnion, error)
POST/v1/sessions/{session_id}/resources/{resource_id}
Delete Session Resource
client.Beta.Sessions.Resources.Delete(ctx, resourceID, params) (*BetaManagedAgentsDeleteSessionResource, error)
DELETE/v1/sessions/{session_id}/resources/{resource_id}

BetaSessionsThreads

List Session Threads
client.Beta.Sessions.Threads.List(ctx, sessionID, params) (*PageCursor[BetaManagedAgentsSessionThread], error)
GET/v1/sessions/{session_id}/threads
Get Session Thread
client.Beta.Sessions.Threads.Get(ctx, threadID, params) (*BetaManagedAgentsSessionThread, error)
GET/v1/sessions/{session_id}/threads/{thread_id}
Archive Session Thread
client.Beta.Sessions.Threads.Archive(ctx, threadID, params) (*BetaManagedAgentsSessionThread, error)
POST/v1/sessions/{session_id}/threads/{thread_id}/archive

BetaSessionsThreadsEvents

List Session Thread Events
client.Beta.Sessions.Threads.Events.List(ctx, threadID, params) (*PageCursor[BetaManagedAgentsSessionEventUnion], error)
GET/v1/sessions/{session_id}/threads/{thread_id}/events
Stream Session Thread Events
client.Beta.Sessions.Threads.Events.Stream(ctx, threadID, params) (*BetaManagedAgentsStreamSessionThreadEventsUnion, error)
GET/v1/sessions/{session_id}/threads/{thread_id}/stream

BetaDeployments

Create Deployment
client.Beta.Deployments.New(ctx, params) (*BetaManagedAgentsDeployment, error)
POST/v1/deployments
List Deployments
client.Beta.Deployments.List(ctx, params) (*PageCursor[BetaManagedAgentsDeployment], error)
GET/v1/deployments
Get Deployment
client.Beta.Deployments.Get(ctx, deploymentID, query) (*BetaManagedAgentsDeployment, error)
GET/v1/deployments/{deployment_id}
Update Deployment
client.Beta.Deployments.Update(ctx, deploymentID, params) (*BetaManagedAgentsDeployment, error)
POST/v1/deployments/{deployment_id}
Archive Deployment
client.Beta.Deployments.Archive(ctx, deploymentID, body) (*BetaManagedAgentsDeployment, error)
POST/v1/deployments/{deployment_id}/archive
Run Deployment Now
client.Beta.Deployments.Run(ctx, deploymentID, body) (*BetaManagedAgentsDeploymentRun, error)
POST/v1/deployments/{deployment_id}/run
Pause Deployment
client.Beta.Deployments.Pause(ctx, deploymentID, body) (*BetaManagedAgentsDeployment, error)
POST/v1/deployments/{deployment_id}/pause
Unpause Deployment
client.Beta.Deployments.Unpause(ctx, deploymentID, body) (*BetaManagedAgentsDeployment, error)
POST/v1/deployments/{deployment_id}/unpause

BetaDeployment Runs

List Deployment Runs
client.Beta.DeploymentRuns.List(ctx, params) (*PageCursor[BetaManagedAgentsDeploymentRun], error)
GET/v1/deployment_runs
Get Deployment Run
client.Beta.DeploymentRuns.Get(ctx, deploymentRunID, query) (*BetaManagedAgentsDeploymentRun, error)
GET/v1/deployment_runs/{deployment_run_id}

BetaVaults

Create Vault
client.Beta.Vaults.New(ctx, params) (*BetaManagedAgentsVault, error)
POST/v1/vaults
List Vaults
client.Beta.Vaults.List(ctx, params) (*PageCursor[BetaManagedAgentsVault], error)
GET/v1/vaults
Get Vault
client.Beta.Vaults.Get(ctx, vaultID, query) (*BetaManagedAgentsVault, error)
GET/v1/vaults/{vault_id}
Update Vault
client.Beta.Vaults.Update(ctx, vaultID, params) (*BetaManagedAgentsVault, error)
POST/v1/vaults/{vault_id}
Delete Vault
client.Beta.Vaults.Delete(ctx, vaultID, body) (*BetaManagedAgentsDeletedVault, error)
DELETE/v1/vaults/{vault_id}
Archive Vault
client.Beta.Vaults.Archive(ctx, vaultID, body) (*BetaManagedAgentsVault, error)
POST/v1/vaults/{vault_id}/archive

BetaVaultsCredentials

Create Credential
client.Beta.Vaults.Credentials.New(ctx, vaultID, params) (*BetaManagedAgentsCredential, error)
POST/v1/vaults/{vault_id}/credentials
List Credentials
client.Beta.Vaults.Credentials.List(ctx, vaultID, params) (*PageCursor[BetaManagedAgentsCredential], error)
GET/v1/vaults/{vault_id}/credentials
Get Credential
client.Beta.Vaults.Credentials.Get(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)
GET/v1/vaults/{vault_id}/credentials/{credential_id}
Update Credential
client.Beta.Vaults.Credentials.Update(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)
POST/v1/vaults/{vault_id}/credentials/{credential_id}
Delete Credential
client.Beta.Vaults.Credentials.Delete(ctx, credentialID, params) (*BetaManagedAgentsDeletedCredential, error)
DELETE/v1/vaults/{vault_id}/credentials/{credential_id}
Archive Credential
client.Beta.Vaults.Credentials.Archive(ctx, credentialID, params) (*BetaManagedAgentsCredential, error)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/archive
Validate Credential
client.Beta.Vaults.Credentials.MCPOAuthValidate(ctx, credentialID, params) (*BetaManagedAgentsCredentialValidation, error)
POST/v1/vaults/{vault_id}/credentials/{credential_id}/mcp_oauth_validate

BetaMemory Stores

Create a memory store
client.Beta.MemoryStores.New(ctx, params) (*BetaManagedAgentsMemoryStore, error)
POST/v1/memory_stores
List memory stores
client.Beta.MemoryStores.List(ctx, params) (*PageCursor[BetaManagedAgentsMemoryStore], error)
GET/v1/memory_stores
Retrieve a memory store
client.Beta.MemoryStores.Get(ctx, memoryStoreID, query) (*BetaManagedAgentsMemoryStore, error)
GET/v1/memory_stores/{memory_store_id}
Update a memory store
client.Beta.MemoryStores.Update(ctx, memoryStoreID, params) (*BetaManagedAgentsMemoryStore, error)
POST/v1/memory_stores/{memory_store_id}
Delete a memory store
client.Beta.MemoryStores.Delete(ctx, memoryStoreID, body) (*BetaManagedAgentsDeletedMemoryStore, error)
DELETE/v1/memory_stores/{memory_store_id}
Archive a memory store
client.Beta.MemoryStores.Archive(ctx, memoryStoreID, body) (*BetaManagedAgentsMemoryStore, error)
POST/v1/memory_stores/{memory_store_id}/archive

BetaMemory StoresMemories

Create a memory
client.Beta.MemoryStores.Memories.New(ctx, memoryStoreID, params) (*BetaManagedAgentsMemory, error)
POST/v1/memory_stores/{memory_store_id}/memories
List memories
client.Beta.MemoryStores.Memories.List(ctx, memoryStoreID, params) (*PageCursor[BetaManagedAgentsMemoryListItemUnion], error)
GET/v1/memory_stores/{memory_store_id}/memories
Retrieve a memory
client.Beta.MemoryStores.Memories.Get(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)
GET/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Update a memory
client.Beta.MemoryStores.Memories.Update(ctx, memoryID, params) (*BetaManagedAgentsMemory, error)
POST/v1/memory_stores/{memory_store_id}/memories/{memory_id}
Delete a memory
client.Beta.MemoryStores.Memories.Delete(ctx, memoryID, params) (*BetaManagedAgentsDeletedMemory, error)
DELETE/v1/memory_stores/{memory_store_id}/memories/{memory_id}

BetaMemory StoresMemory Versions

List memory versions
client.Beta.MemoryStores.MemoryVersions.List(ctx, memoryStoreID, params) (*PageCursor[BetaManagedAgentsMemoryVersion], error)
GET/v1/memory_stores/{memory_store_id}/memory_versions
Retrieve a memory version
client.Beta.MemoryStores.MemoryVersions.Get(ctx, memoryVersionID, params) (*BetaManagedAgentsMemoryVersion, error)
GET/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}
Redact a memory version
client.Beta.MemoryStores.MemoryVersions.Redact(ctx, memoryVersionID, params) (*BetaManagedAgentsMemoryVersion, error)
POST/v1/memory_stores/{memory_store_id}/memory_versions/{memory_version_id}/redact

BetaFiles

Upload File
client.Beta.Files.Upload(ctx, params) (*BetaFileMetadata, error)
POST/v1/files
List Files
client.Beta.Files.List(ctx, params) (*PageCursor[BetaFileMetadata], error)
GET/v1/files
Download File
client.Beta.Files.Download(ctx, fileID, query) (*Response, error)
GET/v1/files/{file_id}/content
Get File Metadata
client.Beta.Files.GetMetadata(ctx, fileID, query) (*BetaFileMetadata, error)
GET/v1/files/{file_id}
Delete File
client.Beta.Files.Delete(ctx, fileID, body) (*BetaDeletedFile, error)
DELETE/v1/files/{file_id}

BetaSkills

Create Skill
client.Beta.Skills.New(ctx, params) (*BetaSkill, error)
POST/v1/skills
List Skills
client.Beta.Skills.List(ctx, params) (*PageCursor[BetaSkill], error)
GET/v1/skills
Get Skill
client.Beta.Skills.Get(ctx, skillID, query) (*BetaSkill, error)
GET/v1/skills/{skill_id}
Delete Skill
client.Beta.Skills.Delete(ctx, skillID, body) (*BetaDeletedSkill, error)
DELETE/v1/skills/{skill_id}

BetaSkillsVersions

Create Skill Version
client.Beta.Skills.Versions.New(ctx, skillID, params) (*BetaSkillVersion, error)
POST/v1/skills/{skill_id}/versions
List Skill Versions
client.Beta.Skills.Versions.List(ctx, skillID, params) (*PageCursor[BetaSkillVersion], error)
GET/v1/skills/{skill_id}/versions
Download Skill Version Content
client.Beta.Skills.Versions.Download(ctx, version, params) (*Response, error)
GET/v1/skills/{skill_id}/versions/{version}/content
Get Skill Version
client.Beta.Skills.Versions.Get(ctx, version, params) (*BetaSkillVersion, error)
GET/v1/skills/{skill_id}/versions/{version}
Delete Skill Version
client.Beta.Skills.Versions.Delete(ctx, version, params) (*BetaDeletedSkillVersion, error)
DELETE/v1/skills/{skill_id}/versions/{version}

BetaWebhooks

Unwrap
client.Beta.Webhooks.Unwrap(ctx) error
Parse Unverified
client.Beta.Webhooks.ParseUnverified(ctx) error

BetaUser Profiles

Create User Profile
client.Beta.UserProfiles.New(ctx, params) (*BetaUserProfile, error)
POST/v1/user_profiles
List User Profiles
client.Beta.UserProfiles.List(ctx, params) (*PageCursor[BetaUserProfile], error)
GET/v1/user_profiles
Get User Profile
client.Beta.UserProfiles.Get(ctx, userProfileID, query) (*BetaUserProfile, error)
GET/v1/user_profiles/{user_profile_id}
Update User Profile
client.Beta.UserProfiles.Update(ctx, userProfileID, params) (*BetaUserProfile, error)
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
client.Beta.UserProfiles.NewEnrollmentURL(ctx, userProfileID, body) (*BetaUserProfileEnrollmentURL, error)
POST/v1/user_profiles/{user_profile_id}/enrollment_url

BetaDreams

Create a Dream
client.Beta.Dreams.New(ctx, params) (*BetaDream, error)
POST/v1/dreams
List Dreams
client.Beta.Dreams.List(ctx, params) (*PageCursor[BetaDream], error)
GET/v1/dreams
Get a Dream
client.Beta.Dreams.Get(ctx, dreamID, query) (*BetaDream, error)
GET/v1/dreams/{dream_id}
Cancel a Dream
client.Beta.Dreams.Cancel(ctx, dreamID, body) (*BetaDream, error)
POST/v1/dreams/{dream_id}/cancel
Archive a Dream
client.Beta.Dreams.Archive(ctx, dreamID, body) (*BetaDream, error)
POST/v1/dreams/{dream_id}/archive

BetaTunnels

Create Tunnel
client.Beta.Tunnels.New(ctx, params) (*BetaTunnel, error)
POST/v1/tunnels
Get Tunnel
client.Beta.Tunnels.Get(ctx, tunnelID, query) (*BetaTunnel, error)
GET/v1/tunnels/{tunnel_id}
List Tunnels
client.Beta.Tunnels.List(ctx, params) (*PageCursor[BetaTunnel], error)
GET/v1/tunnels
Archive Tunnel
client.Beta.Tunnels.Archive(ctx, tunnelID, body) (*BetaTunnel, error)
POST/v1/tunnels/{tunnel_id}/archive
Reveal Tunnel Token
client.Beta.Tunnels.RevealToken(ctx, tunnelID, body) (*BetaTunnelToken, error)
POST/v1/tunnels/{tunnel_id}/reveal_token
Rotate Tunnel Token
client.Beta.Tunnels.RotateToken(ctx, tunnelID, params) (*BetaTunnelToken, error)
POST/v1/tunnels/{tunnel_id}/rotate_token

BetaTunnelsCertificates

Create Tunnel Certificate
client.Beta.Tunnels.Certificates.New(ctx, tunnelID, params) (*BetaTunnelCertificate, error)
POST/v1/tunnels/{tunnel_id}/certificates
Get Tunnel Certificate
client.Beta.Tunnels.Certificates.Get(ctx, certificateID, params) (*BetaTunnelCertificate, error)
GET/v1/tunnels/{tunnel_id}/certificates/{certificate_id}
List Tunnel Certificates
client.Beta.Tunnels.Certificates.List(ctx, tunnelID, params) (*PageCursor[BetaTunnelCertificate], error)
GET/v1/tunnels/{tunnel_id}/certificates
Archive Tunnel Certificate
client.Beta.Tunnels.Certificates.Archive(ctx, certificateID, params) (*BetaTunnelCertificate, error)
POST/v1/tunnels/{tunnel_id}/certificates/{certificate_id}/archive

BetaOrganization

Get Current Organization
client.Beta.Organization.Get(ctx) (*BetaOrganization, error)
GET/v1/organizations/me

BetaOrganizationAPI 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}

BetaOrganizationExternal Keys

Create External Key
client.Beta.Organization.ExternalKeys.New(ctx, body) (*BetaExternalKey, error)
POST/v1/organizations/external_keys
List External Keys
client.Beta.Organization.ExternalKeys.List(ctx, query) (*PageCursor[BetaExternalKey], error)
GET/v1/organizations/external_keys
Get External Key
client.Beta.Organization.ExternalKeys.Get(ctx, externalKeyID) (*BetaExternalKey, error)
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
client.Beta.Organization.ExternalKeys.Update(ctx, externalKeyID, body) (*BetaExternalKey, error)
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
client.Beta.Organization.ExternalKeys.Delete(ctx, externalKeyID) (*BetaOrganizationExternalKeyDeleteResponse, error)
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
client.Beta.Organization.ExternalKeys.Validate(ctx, externalKeyID) (*BetaOrganizationExternalKeyValidateResponse, error)
POST/v1/organizations/external_keys/{external_key_id}/validate

BetaOrganizationFederationIssuers

Create Federation Issuer
client.Beta.Organization.Federation.Issuers.New(ctx, params) (*BetaFederationIssuer, error)
POST/v1/organizations/federation_issuers
List Federation Issuers
client.Beta.Organization.Federation.Issuers.List(ctx, params) (*PageCursor[BetaFederationIssuer], error)
GET/v1/organizations/federation_issuers
Get Federation Issuer
client.Beta.Organization.Federation.Issuers.Get(ctx, federationIssuerID, query) (*BetaFederationIssuer, error)
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
client.Beta.Organization.Federation.Issuers.Update(ctx, federationIssuerID, params) (*BetaFederationIssuer, error)
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
client.Beta.Organization.Federation.Issuers.Archive(ctx, federationIssuerID, body) (*BetaFederationIssuer, error)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

BetaOrganizationFederationRules

Create Federation Rule
client.Beta.Organization.Federation.Rules.New(ctx, params) (*BetaFederationRule, error)
POST/v1/organizations/federation_rules
List Federation Rules
client.Beta.Organization.Federation.Rules.List(ctx, params) (*PageCursor[BetaFederationRule], error)
GET/v1/organizations/federation_rules
Get Federation Rule
client.Beta.Organization.Federation.Rules.Get(ctx, federationRuleID, query) (*BetaFederationRule, error)
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
client.Beta.Organization.Federation.Rules.Update(ctx, federationRuleID, params) (*BetaFederationRule, error)
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
client.Beta.Organization.Federation.Rules.Archive(ctx, federationRuleID, body) (*BetaFederationRule, error)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

BetaOrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
client.Beta.Organization.Federation.Rules.Workspaces.Add(ctx, federationRuleID, params) (*BetaFederationRuleWorkspace, error)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
client.Beta.Organization.Federation.Rules.Workspaces.List(ctx, federationRuleID, params) (*PageCursor[BetaFederationRuleWorkspace], error)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
client.Beta.Organization.Federation.Rules.Workspaces.Remove(ctx, workspaceID, params) (*BetaOrganizationFederationRuleWorkspaceRemoveResponse, error)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

BetaOrganizationInvites

Create Invite
client.Beta.Organization.Invites.New(ctx, body) (*BetaOrganizationInvite, error)
POST/v1/organizations/invites
List Invites
client.Beta.Organization.Invites.List(ctx, query) (*Page[BetaOrganizationInvite], error)
GET/v1/organizations/invites
Get Invite
client.Beta.Organization.Invites.Get(ctx, inviteID) (*BetaOrganizationInvite, error)
GET/v1/organizations/invites/{invite_id}
Delete Invite
client.Beta.Organization.Invites.Delete(ctx, inviteID) (*BetaOrganizationInviteDeleteResponse, error)
DELETE/v1/organizations/invites/{invite_id}

BetaOrganizationService Accounts

Create Service Account
client.Beta.Organization.ServiceAccounts.New(ctx, params) (*BetaServiceAccount, error)
POST/v1/organizations/service_accounts
List Service Accounts
client.Beta.Organization.ServiceAccounts.List(ctx, params) (*PageCursor[BetaServiceAccount], error)
GET/v1/organizations/service_accounts
Get Service Account
client.Beta.Organization.ServiceAccounts.Get(ctx, serviceAccountID, query) (*BetaServiceAccount, error)
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
client.Beta.Organization.ServiceAccounts.Update(ctx, serviceAccountID, params) (*BetaServiceAccount, error)
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
client.Beta.Organization.ServiceAccounts.Archive(ctx, serviceAccountID, body) (*BetaServiceAccount, error)
POST/v1/organizations/service_accounts/{service_account_id}/archive

BetaOrganizationService AccountsWorkspaces

Add Workspace To Service Account
client.Beta.Organization.ServiceAccounts.Workspaces.Add(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
client.Beta.Organization.ServiceAccounts.Workspaces.List(ctx, serviceAccountID, params) (*PageCursor[BetaServiceAccountWorkspaceMember], error)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
client.Beta.Organization.ServiceAccounts.Workspaces.Remove(ctx, workspaceID, params) (*BetaOrganizationServiceAccountWorkspaceRemoveResponse, error)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

BetaOrganizationUsers

List Users
client.Beta.Organization.Users.List(ctx, query) (*Page[BetaOrganizationUser], error)
GET/v1/organizations/users
Get User
client.Beta.Organization.Users.Get(ctx, userID) (*BetaOrganizationUser, error)
GET/v1/organizations/users/{user_id}
Update User
client.Beta.Organization.Users.Update(ctx, userID, body) (*BetaOrganizationUser, error)
POST/v1/organizations/users/{user_id}
Remove User
client.Beta.Organization.Users.Remove(ctx, userID) (*BetaOrganizationUserRemoveResponse, error)
DELETE/v1/organizations/users/{user_id}

BetaOrganizationWorkspaces

List Workspaces
client.Beta.Organization.Workspaces.List(ctx, query) (*Page[BetaWorkspace], error)
GET/v1/organizations/workspaces
Create Workspace
client.Beta.Organization.Workspaces.New(ctx, params) (*BetaWorkspace, error)
POST/v1/organizations/workspaces
Get Workspace
client.Beta.Organization.Workspaces.Get(ctx, workspaceID) (*BetaWorkspace, error)
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
client.Beta.Organization.Workspaces.Update(ctx, workspaceID, body) (*BetaWorkspace, error)
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
client.Beta.Organization.Workspaces.Archive(ctx, workspaceID) (*BetaWorkspace, error)
POST/v1/organizations/workspaces/{workspace_id}/archive

BetaOrganizationWorkspacesRate Limits

List Workspace Rate Limits
client.Beta.Organization.Workspaces.RateLimits.List(ctx, workspaceID, query) (*PageCursor[BetaWorkspaceRateLimit], error)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

BetaOrganizationWorkspacesMembers

List Workspace Members
client.Beta.Organization.Workspaces.Members.List(ctx, workspaceID, query) (*Page[BetaWorkspaceMember], error)
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
client.Beta.Organization.Workspaces.Members.Add(ctx, workspaceID, body) (*BetaWorkspaceMember, error)
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
client.Beta.Organization.Workspaces.Members.Get(ctx, userID, query) (*BetaWorkspaceMember, error)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
client.Beta.Organization.Workspaces.Members.Update(ctx, userID, params) (*BetaWorkspaceMember, error)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
client.Beta.Organization.Workspaces.Members.Remove(ctx, userID, body) (*BetaOrganizationWorkspaceMemberRemoveResponse, error)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

BetaOrganizationWorkspacesService Accounts

List Service Account Workspace Members
client.Beta.Organization.Workspaces.ServiceAccounts.List(ctx, workspaceID, params) (*PageCursor[BetaServiceAccountWorkspaceMember], error)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
client.Beta.Organization.Workspaces.ServiceAccounts.Add(ctx, workspaceID, params) (*BetaServiceAccountWorkspaceMember, error)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
client.Beta.Organization.Workspaces.ServiceAccounts.Get(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
client.Beta.Organization.Workspaces.ServiceAccounts.Update(ctx, serviceAccountID, params) (*BetaServiceAccountWorkspaceMember, error)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
client.Beta.Organization.Workspaces.ServiceAccounts.Remove(ctx, serviceAccountID, params) (*BetaOrganizationWorkspaceServiceAccountRemoveResponse, error)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

BetaOrganizationRate Limits

List Organization Rate Limits
client.Beta.Organization.RateLimits.List(ctx, query) (*PageCursor[BetaOrganizationRateLimit], error)
GET/v1/organizations/rate_limits