Claude Platform Docs

Organization

Get Current Organization
beta.organization.retrieve() -> BetaOrganization
GET/v1/organizations/me
Models
class BetaOrganization: …
id: str

ID of the Organization.

formatuuid
name: str

Name of the Organization.

type: Literal["organization"]

Object type.

For Organizations, this is always "organization".

defaultorganization
Literal["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
beta.organization.api_keys.list(APIKeyListParams**kwargs) -> SyncPage[BetaAPIKey]
GET/v1/organizations/api_keys
Get API Key
beta.organization.api_keys.retrieve(strapi_key_id) -> BetaAPIKey
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
beta.organization.api_keys.update(strapi_key_id, APIKeyUpdateParams**kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
beta.organization.external_keys.create(ExternalKeyCreateParams**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys
List External Keys
beta.organization.external_keys.list(ExternalKeyListParams**kwargs) -> SyncPageCursor[BetaExternalKey]
GET/v1/organizations/external_keys
Get External Key
beta.organization.external_keys.retrieve(strexternal_key_id) -> BetaExternalKey
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
beta.organization.external_keys.update(strexternal_key_id, ExternalKeyUpdateParams**kwargs) -> BetaExternalKey
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
beta.organization.external_keys.delete(strexternal_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
beta.organization.external_keys.validate(strexternal_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

OrganizationFederationIssuers

Create Federation Issuer
beta.organization.federation.issuers.create(IssuerCreateParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers
List Federation Issuers
beta.organization.federation.issuers.list(IssuerListParams**kwargs) -> SyncPageCursor[BetaFederationIssuer]
GET/v1/organizations/federation_issuers
Get Federation Issuer
beta.organization.federation.issuers.retrieve(strfederation_issuer_id, IssuerRetrieveParams**kwargs) -> BetaFederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
beta.organization.federation.issuers.update(strfederation_issuer_id, IssuerUpdateParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
beta.organization.federation.issuers.archive(strfederation_issuer_id, IssuerArchiveParams**kwargs) -> BetaFederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

OrganizationFederationRules

Create Federation Rule
beta.organization.federation.rules.create(RuleCreateParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules
List Federation Rules
beta.organization.federation.rules.list(RuleListParams**kwargs) -> SyncPageCursor[BetaFederationRule]
GET/v1/organizations/federation_rules
Get Federation Rule
beta.organization.federation.rules.retrieve(strfederation_rule_id, RuleRetrieveParams**kwargs) -> BetaFederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
beta.organization.federation.rules.update(strfederation_rule_id, RuleUpdateParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
beta.organization.federation.rules.archive(strfederation_rule_id, RuleArchiveParams**kwargs) -> BetaFederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
beta.organization.federation.rules.workspaces.add(strfederation_rule_id, WorkspaceAddParams**kwargs) -> BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
beta.organization.federation.rules.workspaces.list(strfederation_rule_id, WorkspaceListParams**kwargs) -> SyncPageCursor[BetaFederationRuleWorkspace]
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
beta.organization.federation.rules.workspaces.remove(strworkspace_id, WorkspaceRemoveParams**kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

OrganizationInvites

Create Invite
beta.organization.invites.create(InviteCreateParams**kwargs) -> BetaOrganizationInvite
POST/v1/organizations/invites
List Invites
beta.organization.invites.list(InviteListParams**kwargs) -> SyncPage[BetaOrganizationInvite]
GET/v1/organizations/invites
Get Invite
beta.organization.invites.retrieve(strinvite_id) -> BetaOrganizationInvite
GET/v1/organizations/invites/{invite_id}
Delete Invite
beta.organization.invites.delete(strinvite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

OrganizationService Accounts

Create Service Account
beta.organization.service_accounts.create(ServiceAccountCreateParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts
List Service Accounts
beta.organization.service_accounts.list(ServiceAccountListParams**kwargs) -> SyncPageCursor[BetaServiceAccount]
GET/v1/organizations/service_accounts
Get Service Account
beta.organization.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> BetaServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
beta.organization.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
beta.organization.service_accounts.archive(strservice_account_id, ServiceAccountArchiveParams**kwargs) -> BetaServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

OrganizationService AccountsWorkspaces

Add Workspace To Service Account
beta.organization.service_accounts.workspaces.add(strservice_account_id, WorkspaceAddParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
beta.organization.service_accounts.workspaces.list(strservice_account_id, WorkspaceListParams**kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
beta.organization.service_accounts.workspaces.remove(strworkspace_id, WorkspaceRemoveParams**kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

OrganizationUsers

List Users
beta.organization.users.list(UserListParams**kwargs) -> SyncPage[BetaOrganizationUser]
GET/v1/organizations/users
Get User
beta.organization.users.retrieve(struser_id) -> BetaOrganizationUser
GET/v1/organizations/users/{user_id}
Update User
beta.organization.users.update(struser_id, UserUpdateParams**kwargs) -> BetaOrganizationUser
POST/v1/organizations/users/{user_id}
Remove User
beta.organization.users.remove(struser_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

OrganizationWorkspaces

List Workspaces
beta.organization.workspaces.list(WorkspaceListParams**kwargs) -> SyncPage[BetaWorkspace]
GET/v1/organizations/workspaces
Create Workspace
beta.organization.workspaces.create(WorkspaceCreateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces
Get Workspace
beta.organization.workspaces.retrieve(strworkspace_id) -> BetaWorkspace
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
beta.organization.workspaces.update(strworkspace_id, WorkspaceUpdateParams**kwargs) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
beta.organization.workspaces.archive(strworkspace_id) -> BetaWorkspace
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits
beta.organization.workspaces.rate_limits.list(strworkspace_id, RateLimitListParams**kwargs) -> SyncPageCursor[BetaWorkspaceRateLimit]
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

OrganizationWorkspacesMembers

List Workspace Members
beta.organization.workspaces.members.list(strworkspace_id, MemberListParams**kwargs) -> SyncPage[BetaWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
beta.organization.workspaces.members.add(strworkspace_id, MemberAddParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
beta.organization.workspaces.members.retrieve(struser_id, MemberRetrieveParams**kwargs) -> BetaWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
beta.organization.workspaces.members.update(struser_id, MemberUpdateParams**kwargs) -> BetaWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
beta.organization.workspaces.members.remove(struser_id, MemberRemoveParams**kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(strworkspace_id, ServiceAccountListParams**kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
beta.organization.workspaces.service_accounts.add(strworkspace_id, ServiceAccountAddParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
beta.organization.workspaces.service_accounts.retrieve(strservice_account_id, ServiceAccountRetrieveParams**kwargs) -> BetaServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
beta.organization.workspaces.service_accounts.update(strservice_account_id, ServiceAccountUpdateParams**kwargs) -> BetaServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
beta.organization.workspaces.service_accounts.remove(strservice_account_id, ServiceAccountRemoveParams**kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

OrganizationRate Limits

List Organization Rate Limits
beta.organization.rate_limits.list(RateLimitListParams**kwargs) -> SyncPageCursor[BetaOrganizationRateLimit]
GET/v1/organizations/rate_limits