Organization

Get Current Organization

beta.organization.retrieve() -> BetaOrganization

GET/v1/organizations/me

Models

class 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".

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

beta.organization.api_keys.list(**kwargs) -> Page<BetaAPIKey>

GET/v1/organizations/api_keys

Get API Key

beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey

GET/v1/organizations/api_keys/{api_key_id}

Update API Key

beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey

POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key

beta.organization.external_keys.create(**kwargs) -> BetaExternalKey

POST/v1/organizations/external_keys

List External Keys

beta.organization.external_keys.list(**kwargs) -> PageCursor<BetaExternalKey>

GET/v1/organizations/external_keys

Get External Key

beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKey

GET/v1/organizations/external_keys/{external_key_id}

Update External Key

beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKey

POST/v1/organizations/external_keys/{external_key_id}

Delete External Key

beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse

DELETE/v1/organizations/external_keys/{external_key_id}

Validate External Key

beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse

POST/v1/organizations/external_keys/{external_key_id}/validate

OrganizationFederationIssuers

Create Federation Issuer

beta.organization.federation.issuers.create(**kwargs) -> BetaFederationIssuer

POST/v1/organizations/federation_issuers

List Federation Issuers

beta.organization.federation.issuers.list(**kwargs) -> PageCursor<BetaFederationIssuer>

GET/v1/organizations/federation_issuers

Get Federation Issuer

beta.organization.federation.issuers.retrieve(federation_issuer_id, **kwargs) -> BetaFederationIssuer

GET/v1/organizations/federation_issuers/{federation_issuer_id}

Update Federation Issuer

beta.organization.federation.issuers.update(federation_issuer_id, **kwargs) -> BetaFederationIssuer

POST/v1/organizations/federation_issuers/{federation_issuer_id}

Archive Federation Issuer

beta.organization.federation.issuers.archive(federation_issuer_id, **kwargs) -> BetaFederationIssuer

POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

OrganizationFederationRules

Create Federation Rule

beta.organization.federation.rules.create(**kwargs) -> BetaFederationRule

POST/v1/organizations/federation_rules

List Federation Rules

beta.organization.federation.rules.list(**kwargs) -> PageCursor<BetaFederationRule>

GET/v1/organizations/federation_rules

Get Federation Rule

beta.organization.federation.rules.retrieve(federation_rule_id, **kwargs) -> BetaFederationRule

GET/v1/organizations/federation_rules/{federation_rule_id}

Update Federation Rule

beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRule

POST/v1/organizations/federation_rules/{federation_rule_id}

Archive Federation Rule

beta.organization.federation.rules.archive(federation_rule_id, **kwargs) -> BetaFederationRule

POST/v1/organizations/federation_rules/{federation_rule_id}/archive

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace

beta.organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> BetaFederationRuleWorkspace

POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

List Federation Rule Workspaces

beta.organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> PageCursor<BetaFederationRuleWorkspace>

GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Remove Federation Rule Workspace

beta.organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse

DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

OrganizationInvites

Create Invite

beta.organization.invites.create(**kwargs) -> BetaOrganizationInvite

POST/v1/organizations/invites

List Invites

beta.organization.invites.list(**kwargs) -> Page<BetaOrganizationInvite>

GET/v1/organizations/invites

Get Invite

beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInvite

GET/v1/organizations/invites/{invite_id}

Delete Invite

beta.organization.invites.delete(invite_id) -> InviteDeleteResponse

DELETE/v1/organizations/invites/{invite_id}

OrganizationService Accounts

Create Service Account

beta.organization.service_accounts.create(**kwargs) -> BetaServiceAccount

POST/v1/organizations/service_accounts

List Service Accounts

beta.organization.service_accounts.list(**kwargs) -> PageCursor<BetaServiceAccount>

GET/v1/organizations/service_accounts

Get Service Account

beta.organization.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccount

GET/v1/organizations/service_accounts/{service_account_id}

Update Service Account

beta.organization.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccount

POST/v1/organizations/service_accounts/{service_account_id}

Archive Service Account

beta.organization.service_accounts.archive(service_account_id, **kwargs) -> BetaServiceAccount

POST/v1/organizations/service_accounts/{service_account_id}/archive

OrganizationService AccountsWorkspaces

Add Workspace To Service Account

beta.organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember

POST/v1/organizations/service_accounts/{service_account_id}/workspaces

List Workspaces For Service Account

beta.organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> PageCursor<BetaServiceAccountWorkspaceMember>

GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Remove Workspace From Service Account

beta.organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse

DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

OrganizationUsers

List Users

beta.organization.users.list(**kwargs) -> Page<BetaOrganizationUser>

GET/v1/organizations/users

Get User

beta.organization.users.retrieve(user_id) -> BetaOrganizationUser

GET/v1/organizations/users/{user_id}

Update User

beta.organization.users.update(user_id, **kwargs) -> BetaOrganizationUser

POST/v1/organizations/users/{user_id}

Remove User

beta.organization.users.remove(user_id) -> UserRemoveResponse

DELETE/v1/organizations/users/{user_id}

OrganizationWorkspaces

List Workspaces

beta.organization.workspaces.list(**kwargs) -> Page<BetaWorkspace>

GET/v1/organizations/workspaces

Create Workspace

beta.organization.workspaces.create(**kwargs) -> BetaWorkspace

POST/v1/organizations/workspaces

Get Workspace

beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspace

GET/v1/organizations/workspaces/{workspace_id}

Update Workspace

beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspace

POST/v1/organizations/workspaces/{workspace_id}

Archive Workspace

beta.organization.workspaces.archive(workspace_id) -> BetaWorkspace

POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits

beta.organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> PageCursor<BetaWorkspaceRateLimit>

GET/v1/organizations/workspaces/{workspace_id}/rate_limits

OrganizationWorkspacesMembers

List Workspace Members

beta.organization.workspaces.members.list(workspace_id, **kwargs) -> Page<BetaWorkspaceMember>

GET/v1/organizations/workspaces/{workspace_id}/members

Create Workspace Member

beta.organization.workspaces.members.add(workspace_id, **kwargs) -> BetaWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/members

Get Workspace Member

beta.organization.workspaces.members.retrieve(user_id, **kwargs) -> BetaWorkspaceMember

GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Update Workspace Member

beta.organization.workspaces.members.update(user_id, **kwargs) -> BetaWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Delete Workspace Member

beta.organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse

DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members

beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> PageCursor<BetaServiceAccountWorkspaceMember>

GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Create Service Account Workspace Member

beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Get Service Account Workspace Member

beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember

GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Update Service Account Workspace Member

beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Delete Service Account Workspace Member

beta.organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse

DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

OrganizationRate Limits

List Organization Rate Limits

beta.organization.rate_limits.list(**kwargs) -> PageCursor<BetaOrganizationRateLimit>

GET/v1/organizations/rate_limits