Claude Platform Docs

Organization

Get Current Organization
organization.retrieve() -> OrganizationInfo
GET/v1/organizations/me

Retrieve information about the organization associated with the authenticated API key.

Models
class OrganizationInfo: type: "organization"; id; name
type: Literal["organization"]

Object type.

For Organizations, this is always "organization".

defaultorganization
id: str

ID of the Organization.

formatuuid
name: str

Name of the Organization.

type OrganizationRole = 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
organization.api_keys.list(**kwargs) -> SyncPage[APIKey]
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
organization.api_keys.retrieve(api_key_id) -> APIKey
GET/v1/organizations/api_keys/{api_key_id}

Retrieve information about a single API key in your organization, looked up by its ID. This Admin API endpoint requires an Admin API key, is intended for programmatic key management, and never returns the key's secret value. To view or create your own API keys, go to API keys in the Claude Console.

Update API Key
organization.api_keys.update(api_key_id, **kwargs) -> APIKey
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
organization.external_keys.create(**kwargs) -> ExternalKey
POST/v1/organizations/external_keys

Create an external key config owned by the caller's organization.

List External Keys
organization.external_keys.list(**kwargs) -> SyncPageCursor[ExternalKey]
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
organization.external_keys.retrieve(external_key_id) -> ExternalKey
GET/v1/organizations/external_keys/{external_key_id}

Retrieve a single external key config in the caller's organization by ID.

Update External Key
organization.external_keys.update(external_key_id, **kwargs) -> ExternalKey
POST/v1/organizations/external_keys/{external_key_id}

Partially update an external key config. Omitted fields are left unchanged.

Delete External Key
organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponse
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponse
POST/v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

OrganizationFederationIssuers

Create Federation Issuer
organization.federation.issuers.create(**kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Issuers
organization.federation.issuers.list(**kwargs) -> SyncPageCursor[FederationIssuer]
GET/v1/organizations/federation_issuers

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Issuer
organization.federation.issuers.retrieve(federation_issuer_id) -> FederationIssuer
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Issuer
organization.federation.issuers.update(federation_issuer_id, **kwargs) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Issuer
organization.federation.issuers.archive(federation_issuer_id) -> FederationIssuer
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationFederationRules

Create Federation Rule
organization.federation.rules.create(**kwargs) -> FederationRule
POST/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rules
organization.federation.rules.list(**kwargs) -> SyncPageCursor[FederationRule]
GET/v1/organizations/federation_rules

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Federation Rule
organization.federation.rules.retrieve(federation_rule_id) -> FederationRule
GET/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Federation Rule
organization.federation.rules.update(federation_rule_id, **kwargs) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Federation Rule
organization.federation.rules.archive(federation_rule_id) -> FederationRule
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationFederationRulesWorkspaces

Add Federation Rule Workspace
organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> FederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Federation Rule Workspaces
organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[FederationRuleWorkspace]
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Federation Rule Workspace
organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationInvites

Create Invite
organization.invites.create(**kwargs) -> OrganizationInvite
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
organization.invites.list(**kwargs) -> SyncPage[OrganizationInvite]
GET/v1/organizations/invites

List the organization's invites.

Get Invite
organization.invites.retrieve(invite_id) -> OrganizationInvite
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
organization.invites.delete(invite_id) -> InviteDeleteResponse
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

OrganizationService Accounts

Create Service Account
organization.service_accounts.create(**kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Service Accounts
organization.service_accounts.list(**kwargs) -> SyncPageCursor[ServiceAccount]
GET/v1/organizations/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account
organization.service_accounts.retrieve(service_account_id) -> ServiceAccount
GET/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account
organization.service_accounts.update(service_account_id, **kwargs) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Archive Service Account
organization.service_accounts.archive(service_account_id) -> ServiceAccount
POST/v1/organizations/service_accounts/{service_account_id}/archive

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationService AccountsWorkspaces

Add Workspace To Service Account
organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

List Workspaces For Service Account
organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Remove Workspace From Service Account
organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponse
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationUsers

List Users
organization.users.list(**kwargs) -> SyncPage[OrganizationUser]
GET/v1/organizations/users

List the organization's members.

Get User
organization.users.retrieve(user_id) -> OrganizationUser
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
organization.users.update(user_id, **kwargs) -> OrganizationUser
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
organization.users.remove(user_id) -> UserRemoveResponse
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

OrganizationWorkspaces

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

OrganizationWorkspacesRate Limits

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

List a workspace's rate limits.

OrganizationWorkspacesMembers

List Workspace Members
organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[WorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
organization.workspaces.members.add(workspace_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
organization.workspaces.members.retrieve(user_id, **kwargs) -> WorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
organization.workspaces.members.update(user_id, **kwargs) -> WorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[ServiceAccountWorkspaceMember]
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Create Service Account Workspace Member
organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Get Service Account Workspace Member
organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Update Service Account Workspace Member
organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> ServiceAccountWorkspaceMember
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

Delete Service Account Workspace Member
organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponse
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Requires an OAuth access token with the org:admin scope, from ant auth login --scope org:admin or a workload identity federation rule; Admin API keys are not accepted. See Manage WIF with the Admin API.

OrganizationRate Limits

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

List Messages API rate limits for your organization.

OrganizationCompliance Settings

Get Compliance Settings
organization.compliance_settings.retrieve() -> OrganizationComplianceSettings
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
organization.compliance_settings.update(**kwargs) -> OrganizationComplianceSettings
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.