Claude Platform Docs

Organization

Get Current Organization
client.beta.organization.retrieve(RequestOptionsoptions?): BetaOrganization
GET/v1/organizations/me
Models
BetaOrganization { id, name, type }
id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization
BetaOrganizationRole = "admin" | "billing" | "claude_code_user" | 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganizationAPI Keys

List API Keys
client.beta.organization.apiKeys.list(APIKeyListParamsquery?, RequestOptionsoptions?): Page<BetaAPIKey>
GET/v1/organizations/api_keys
Get API Key
client.beta.organization.apiKeys.retrieve(stringapiKeyID, RequestOptionsoptions?): BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
client.beta.organization.apiKeys.update(stringapiKeyID, APIKeyUpdateParamsbody, RequestOptionsoptions?): BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
client.beta.organization.externalKeys.create(ExternalKeyCreateParamsbody, RequestOptionsoptions?): BetaExternalKey
POST/v1/organizations/external_keys
List External Keys
client.beta.organization.externalKeys.list(ExternalKeyListParamsquery?, RequestOptionsoptions?): PageCursor<BetaExternalKey>
GET/v1/organizations/external_keys
Get External Key
client.beta.organization.externalKeys.retrieve(stringexternalKeyID, RequestOptionsoptions?): BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
client.beta.organization.externalKeys.update(stringexternalKeyID, ExternalKeyUpdateParamsbody, RequestOptionsoptions?): BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
client.beta.organization.externalKeys.delete(stringexternalKeyID, RequestOptionsoptions?): ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
client.beta.organization.externalKeys.validate(stringexternalKeyID, RequestOptionsoptions?): ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

OrganizationFederationIssuers

Create Federation Issuer
client.beta.organization.federation.issuers.create(IssuerCreateParamsparams, RequestOptionsoptions?): BetaFederationIssuer
POST/v1/organizations/federation_issuers
List Federation Issuers
client.beta.organization.federation.issuers.list(IssuerListParamsparams?, RequestOptionsoptions?): PageCursor<BetaFederationIssuer>
GET/v1/organizations/federation_issuers
Get Federation Issuer
client.beta.organization.federation.issuers.retrieve(stringfederationIssuerID, IssuerRetrieveParamsparams?, RequestOptionsoptions?): BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
client.beta.organization.federation.issuers.update(stringfederationIssuerID, IssuerUpdateParamsparams, RequestOptionsoptions?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
client.beta.organization.federation.issuers.archive(stringfederationIssuerID, IssuerArchiveParamsparams?, RequestOptionsoptions?): BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

OrganizationFederationRules

Create Federation Rule
client.beta.organization.federation.rules.create(RuleCreateParamsparams, RequestOptionsoptions?): BetaFederationRule
POST/v1/organizations/federation_rules
List Federation Rules
client.beta.organization.federation.rules.list(RuleListParamsparams?, RequestOptionsoptions?): PageCursor<BetaFederationRule>
GET/v1/organizations/federation_rules
Get Federation Rule
client.beta.organization.federation.rules.retrieve(stringfederationRuleID, RuleRetrieveParamsparams?, RequestOptionsoptions?): BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
client.beta.organization.federation.rules.update(stringfederationRuleID, RuleUpdateParamsparams, RequestOptionsoptions?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
client.beta.organization.federation.rules.archive(stringfederationRuleID, RuleArchiveParamsparams?, RequestOptionsoptions?): BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
client.beta.organization.federation.rules.workspaces.add(stringfederationRuleID, WorkspaceAddParamsparams, RequestOptionsoptions?): BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
client.beta.organization.federation.rules.workspaces.list(stringfederationRuleID, WorkspaceListParamsparams?, RequestOptionsoptions?): PageCursor<BetaFederationRuleWorkspace>
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
client.beta.organization.federation.rules.workspaces.remove(stringworkspaceID, WorkspaceRemoveParamsparams, RequestOptionsoptions?): WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

OrganizationInvites

Create Invite
client.beta.organization.invites.create(InviteCreateParamsbody, RequestOptionsoptions?): BetaOrganizationInvite
POST/v1/organizations/invites
List Invites
client.beta.organization.invites.list(InviteListParamsquery?, RequestOptionsoptions?): Page<BetaOrganizationInvite>
GET/v1/organizations/invites
Get Invite
client.beta.organization.invites.retrieve(stringinviteID, RequestOptionsoptions?): BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}
Delete Invite
client.beta.organization.invites.delete(stringinviteID, RequestOptionsoptions?): InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

OrganizationService Accounts

Create Service Account
client.beta.organization.serviceAccounts.create(ServiceAccountCreateParamsparams, RequestOptionsoptions?): BetaServiceAccount
POST/v1/organizations/service_accounts
List Service Accounts
client.beta.organization.serviceAccounts.list(ServiceAccountListParamsparams?, RequestOptionsoptions?): PageCursor<BetaServiceAccount>
GET/v1/organizations/service_accounts
Get Service Account
client.beta.organization.serviceAccounts.retrieve(stringserviceAccountID, ServiceAccountRetrieveParamsparams?, RequestOptionsoptions?): BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
client.beta.organization.serviceAccounts.update(stringserviceAccountID, ServiceAccountUpdateParamsparams, RequestOptionsoptions?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
client.beta.organization.serviceAccounts.archive(stringserviceAccountID, ServiceAccountArchiveParamsparams?, RequestOptionsoptions?): BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

OrganizationService AccountsWorkspaces

Add Workspace To Service Account
client.beta.organization.serviceAccounts.workspaces.add(stringserviceAccountID, WorkspaceAddParamsparams, RequestOptionsoptions?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
client.beta.organization.serviceAccounts.workspaces.list(stringserviceAccountID, WorkspaceListParamsparams?, RequestOptionsoptions?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
client.beta.organization.serviceAccounts.workspaces.remove(stringworkspaceID, WorkspaceRemoveParamsparams, RequestOptionsoptions?): WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

OrganizationUsers

List Users
client.beta.organization.users.list(UserListParamsquery?, RequestOptionsoptions?): Page<BetaOrganizationUser>
GET/v1/organizations/users
Get User
client.beta.organization.users.retrieve(stringuserID, RequestOptionsoptions?): BetaOrganizationUser
GET/v1/organizations/users/{user_id}
Update User
client.beta.organization.users.update(stringuserID, UserUpdateParamsbody, RequestOptionsoptions?): BetaOrganizationUser
POST/v1/organizations/users/{user_id}
Remove User
client.beta.organization.users.remove(stringuserID, RequestOptionsoptions?): UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

OrganizationWorkspaces

List Workspaces
client.beta.organization.workspaces.list(WorkspaceListParamsquery?, RequestOptionsoptions?): Page<BetaWorkspace>
GET/v1/organizations/workspaces
Create Workspace
client.beta.organization.workspaces.create(WorkspaceCreateParamsparams, RequestOptionsoptions?): BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
client.beta.organization.workspaces.retrieve(stringworkspaceID, RequestOptionsoptions?): BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
client.beta.organization.workspaces.update(stringworkspaceID, WorkspaceUpdateParamsbody, RequestOptionsoptions?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
client.beta.organization.workspaces.archive(stringworkspaceID, RequestOptionsoptions?): BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits
client.beta.organization.workspaces.rateLimits.list(stringworkspaceID, RateLimitListParamsquery?, RequestOptionsoptions?): PageCursor<BetaWorkspaceRateLimit>
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

OrganizationWorkspacesMembers

List Workspace Members
client.beta.organization.workspaces.members.list(stringworkspaceID, MemberListParamsquery?, RequestOptionsoptions?): Page<BetaWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
client.beta.organization.workspaces.members.add(stringworkspaceID, MemberAddParamsbody, RequestOptionsoptions?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
client.beta.organization.workspaces.members.retrieve(stringuserID, MemberRetrieveParamsparams, RequestOptionsoptions?): BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
client.beta.organization.workspaces.members.update(stringuserID, MemberUpdateParamsparams, RequestOptionsoptions?): BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
client.beta.organization.workspaces.members.remove(stringuserID, MemberRemoveParamsparams, RequestOptionsoptions?): MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
client.beta.organization.workspaces.serviceAccounts.list(stringworkspaceID, ServiceAccountListParamsparams?, RequestOptionsoptions?): PageCursor<BetaServiceAccountWorkspaceMember>
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
client.beta.organization.workspaces.serviceAccounts.add(stringworkspaceID, ServiceAccountAddParamsparams, RequestOptionsoptions?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
client.beta.organization.workspaces.serviceAccounts.retrieve(stringserviceAccountID, ServiceAccountRetrieveParamsparams, RequestOptionsoptions?): BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
client.beta.organization.workspaces.serviceAccounts.update(stringserviceAccountID, ServiceAccountUpdateParamsparams, RequestOptionsoptions?): BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
client.beta.organization.workspaces.serviceAccounts.remove(stringserviceAccountID, ServiceAccountRemoveParamsparams, RequestOptionsoptions?): ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

OrganizationRate Limits

List Organization Rate Limits
client.beta.organization.rateLimits.list(RateLimitListParamsquery?, RequestOptionsoptions?): PageCursor<BetaOrganizationRateLimit>
GET/v1/organizations/rate_limits