Claude Platform Docs

Organization

Get Current Organization
BetaOrganization beta().organization().retrieve(OrganizationRetrieveParamsparams = OrganizationRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/me
Models
class BetaOrganization:
String id

ID of the Organization.

formatuuid
String name

Name of the Organization.

JsonValue type "organization"constant

Object type.

For Organizations, this is always "organization".

enum BetaOrganizationRole:
ADMIN("admin")
BILLING("billing")
CLAUDE_CODE_USER("claude_code_user")
DEVELOPER("developer")
MANAGED("managed")
MEMBERSHIP_ADMIN("membership_admin")
OWNER("owner")
PRIMARY_OWNER("primary_owner")
USER("user")

OrganizationAPI Keys

List API Keys
ApiKeyListPage beta().organization().apiKeys().list(ApiKeyListParamsparams = ApiKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Get API Key
BetaApiKey beta().organization().apiKeys().retrieve(ApiKeyRetrieveParamsparams = ApiKeyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}
Update API Key
BetaApiKey beta().organization().apiKeys().update(ApiKeyUpdateParamsparams = ApiKeyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
BetaExternalKey beta().organization().externalKeys().create(ExternalKeyCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys
List External Keys
ExternalKeyListPage beta().organization().externalKeys().list(ExternalKeyListParamsparams = ExternalKeyListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/external_keys
Get External Key
BetaExternalKey beta().organization().externalKeys().retrieve(ExternalKeyRetrieveParamsparams = ExternalKeyRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}
Update External Key
BetaExternalKey beta().organization().externalKeys().update(ExternalKeyUpdateParamsparams = ExternalKeyUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}
Delete External Key
ExternalKeyDeleteResponse beta().organization().externalKeys().delete(ExternalKeyDeleteParamsparams = ExternalKeyDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}
Validate External Key
ExternalKeyValidateResponse beta().organization().externalKeys().validate(ExternalKeyValidateParamsparams = ExternalKeyValidateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

OrganizationFederationIssuers

Create Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().create(IssuerCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers
List Federation Issuers
IssuerListPage beta().organization().federation().issuers().list(IssuerListParamsparams = IssuerListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers
Get Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().retrieve(IssuerRetrieveParamsparams = IssuerRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_id}
Update Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().update(IssuerUpdateParamsparams = IssuerUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}
Archive Federation Issuer
BetaFederationIssuer beta().organization().federation().issuers().archive(IssuerArchiveParamsparams = IssuerArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

OrganizationFederationRules

Create Federation Rule
BetaFederationRule beta().organization().federation().rules().create(RuleCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules
List Federation Rules
RuleListPage beta().organization().federation().rules().list(RuleListParamsparams = RuleListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules
Get Federation Rule
BetaFederationRule beta().organization().federation().rules().retrieve(RuleRetrieveParamsparams = RuleRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}
Update Federation Rule
BetaFederationRule beta().organization().federation().rules().update(RuleUpdateParamsparams = RuleUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}
Archive Federation Rule
BetaFederationRule beta().organization().federation().rules().archive(RuleArchiveParamsparams = RuleArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
BetaFederationRuleWorkspace beta().organization().federation().rules().workspaces().add(WorkspaceAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces
List Federation Rule Workspaces
WorkspaceListPage beta().organization().federation().rules().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces
Remove Federation Rule Workspace
WorkspaceRemoveResponse beta().organization().federation().rules().workspaces().remove(WorkspaceRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

OrganizationInvites

Create Invite
BetaOrganizationInvite beta().organization().invites().create(InviteCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/invites
List Invites
InviteListPage beta().organization().invites().list(InviteListParamsparams = InviteListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/invites
Get Invite
BetaOrganizationInvite beta().organization().invites().retrieve(InviteRetrieveParamsparams = InviteRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}
Delete Invite
InviteDeleteResponse beta().organization().invites().delete(InviteDeleteParamsparams = InviteDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

OrganizationService Accounts

Create Service Account
BetaServiceAccount beta().organization().serviceAccounts().create(ServiceAccountCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts
List Service Accounts
ServiceAccountListPage beta().organization().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts
Get Service Account
BetaServiceAccount beta().organization().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams = ServiceAccountRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}
Update Service Account
BetaServiceAccount beta().organization().serviceAccounts().update(ServiceAccountUpdateParamsparams = ServiceAccountUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}
Archive Service Account
BetaServiceAccount beta().organization().serviceAccounts().archive(ServiceAccountArchiveParamsparams = ServiceAccountArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

OrganizationService AccountsWorkspaces

Add Workspace To Service Account
BetaServiceAccountWorkspaceMember beta().organization().serviceAccounts().workspaces().add(WorkspaceAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces
List Workspaces For Service Account
WorkspaceListPage beta().organization().serviceAccounts().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces
Remove Workspace From Service Account
WorkspaceRemoveResponse beta().organization().serviceAccounts().workspaces().remove(WorkspaceRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

OrganizationUsers

List Users
UserListPage beta().organization().users().list(UserListParamsparams = UserListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/users
Get User
BetaOrganizationUser beta().organization().users().retrieve(UserRetrieveParamsparams = UserRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}
Update User
BetaOrganizationUser beta().organization().users().update(UserUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}
Remove User
UserRemoveResponse beta().organization().users().remove(UserRemoveParamsparams = UserRemoveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

OrganizationWorkspaces

List Workspaces
WorkspaceListPage beta().organization().workspaces().list(WorkspaceListParamsparams = WorkspaceListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace beta().organization().workspaces().create(WorkspaceCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace beta().organization().workspaces().retrieve(WorkspaceRetrieveParamsparams = WorkspaceRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace beta().organization().workspaces().update(WorkspaceUpdateParamsparams = WorkspaceUpdateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace beta().organization().workspaces().archive(WorkspaceArchiveParamsparams = WorkspaceArchiveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage beta().organization().workspaces().rateLimits().list(RateLimitListParamsparams = RateLimitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

OrganizationWorkspacesMembers

List Workspace Members
MemberListPage beta().organization().workspaces().members().list(MemberListParamsparams = MemberListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().add(MemberAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().retrieve(MemberRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember beta().organization().workspaces().members().update(MemberUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse beta().organization().workspaces().members().remove(MemberRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage beta().organization().workspaces().serviceAccounts().list(ServiceAccountListParamsparams = ServiceAccountListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts
Create Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().add(ServiceAccountAddParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts
Get Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().retrieve(ServiceAccountRetrieveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Update Service Account Workspace Member
BetaServiceAccountWorkspaceMember beta().organization().workspaces().serviceAccounts().update(ServiceAccountUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}
Delete Service Account Workspace Member
ServiceAccountRemoveResponse beta().organization().workspaces().serviceAccounts().remove(ServiceAccountRemoveParamsparams, RequestOptionsrequestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

OrganizationRate Limits

List Organization Rate Limits
RateLimitListPage beta().organization().rateLimits().list(RateLimitListParamsparams = RateLimitListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits