Organization
Get Current Organization
beta.organization.retrieve() -> BetaOrganizationRetrieve information about the organization associated with the authenticated API key.
Models
OrganizationAPI Keys
List API Keys
beta.organization.api_keys.list(**kwargs) -> SyncPage[BetaAPIKey]Retrieve API Key (Admin API)
beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKeyRetrieve 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
beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKeyOrganizationExternal Keys
Create External Key
beta.organization.external_keys.create(**kwargs) -> BetaExternalKeyCreate an external key config owned by the caller's organization.
List External Keys
beta.organization.external_keys.list(**kwargs) -> SyncPageCursor[BetaExternalKey]List external key configs in the caller's organization.
Get External Key
beta.organization.external_keys.retrieve(external_key_id) -> BetaExternalKeyRetrieve a single external key config in the caller's organization by ID.
Update External Key
beta.organization.external_keys.update(external_key_id, **kwargs) -> BetaExternalKeyPartially update an external key config. Omitted fields are left unchanged.
Delete External Key
beta.organization.external_keys.delete(external_key_id) -> ExternalKeyDeleteResponseDelete an external key config.
Validate External Key
beta.organization.external_keys.validate(external_key_id) -> ExternalKeyValidateResponseValidate an external key config against the customer's KMS.
OrganizationFederationIssuers
Create Federation Issuer
beta.organization.federation.issuers.create(**kwargs) -> BetaFederationIssuerRequires 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
beta.organization.federation.issuers.list(**kwargs) -> SyncPageCursor[BetaFederationIssuer]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
beta.organization.federation.issuers.retrieve(federation_issuer_id, **kwargs) -> BetaFederationIssuerRequires 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
beta.organization.federation.issuers.update(federation_issuer_id, **kwargs) -> BetaFederationIssuerRequires 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
beta.organization.federation.issuers.archive(federation_issuer_id, **kwargs) -> BetaFederationIssuerRequires 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
beta.organization.federation.rules.create(**kwargs) -> BetaFederationRuleRequires 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
beta.organization.federation.rules.list(**kwargs) -> SyncPageCursor[BetaFederationRule]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
beta.organization.federation.rules.retrieve(federation_rule_id, **kwargs) -> BetaFederationRuleRequires 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
beta.organization.federation.rules.update(federation_rule_id, **kwargs) -> BetaFederationRuleRequires 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
beta.organization.federation.rules.archive(federation_rule_id, **kwargs) -> BetaFederationRuleRequires 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
beta.organization.federation.rules.workspaces.add(federation_rule_id, **kwargs) -> BetaFederationRuleWorkspaceRequires 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
beta.organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> SyncPageCursor[BetaFederationRuleWorkspace]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
beta.organization.federation.rules.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponseRequires 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
beta.organization.invites.create(**kwargs) -> BetaOrganizationInviteInvite a user to join the organization by email.
List Invites
beta.organization.invites.list(**kwargs) -> SyncPage[BetaOrganizationInvite]List the organization's invites.
Get Invite
beta.organization.invites.retrieve(invite_id) -> BetaOrganizationInviteRetrieve an invite by ID.
Delete Invite
beta.organization.invites.delete(invite_id) -> InviteDeleteResponseDelete a pending invite.
OrganizationService Accounts
Create Service Account
beta.organization.service_accounts.create(**kwargs) -> BetaServiceAccountRequires 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
beta.organization.service_accounts.list(**kwargs) -> SyncPageCursor[BetaServiceAccount]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
beta.organization.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountRequires 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
beta.organization.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountRequires 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
beta.organization.service_accounts.archive(service_account_id, **kwargs) -> BetaServiceAccountRequires 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
beta.organization.service_accounts.workspaces.add(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMemberRequires 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
beta.organization.service_accounts.workspaces.list(service_account_id, **kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]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
beta.organization.service_accounts.workspaces.remove(workspace_id, **kwargs) -> WorkspaceRemoveResponseRequires 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
beta.organization.users.list(**kwargs) -> SyncPage[BetaOrganizationUser]List the organization's members.
Get User
beta.organization.users.retrieve(user_id) -> BetaOrganizationUserRetrieve a member of the organization by user ID.
Update User
beta.organization.users.update(user_id, **kwargs) -> BetaOrganizationUserUpdate a member's organization role.
Remove User
beta.organization.users.remove(user_id) -> UserRemoveResponseRemove a member from the organization.
OrganizationWorkspaces
List Workspaces
beta.organization.workspaces.list(**kwargs) -> SyncPage[BetaWorkspace]Create Workspace
beta.organization.workspaces.create(**kwargs) -> BetaWorkspaceGet Workspace
beta.organization.workspaces.retrieve(workspace_id) -> BetaWorkspaceUpdate Workspace
beta.organization.workspaces.update(workspace_id, **kwargs) -> BetaWorkspaceArchive Workspace
beta.organization.workspaces.archive(workspace_id) -> BetaWorkspaceOrganizationWorkspacesRate Limits
List Workspace Rate Limits
beta.organization.workspaces.rate_limits.list(workspace_id, **kwargs) -> SyncPageCursor[BetaWorkspaceRateLimit]List a workspace's rate limits.
OrganizationWorkspacesMembers
List Workspace Members
beta.organization.workspaces.members.list(workspace_id, **kwargs) -> SyncPage[BetaWorkspaceMember]Create Workspace Member
beta.organization.workspaces.members.add(workspace_id, **kwargs) -> BetaWorkspaceMemberGet Workspace Member
beta.organization.workspaces.members.retrieve(user_id, **kwargs) -> BetaWorkspaceMemberUpdate Workspace Member
beta.organization.workspaces.members.update(user_id, **kwargs) -> BetaWorkspaceMemberDelete Workspace Member
beta.organization.workspaces.members.remove(user_id, **kwargs) -> MemberRemoveResponseOrganizationWorkspacesService Accounts
List Service Account Workspace Members
beta.organization.workspaces.service_accounts.list(workspace_id, **kwargs) -> SyncPageCursor[BetaServiceAccountWorkspaceMember]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
beta.organization.workspaces.service_accounts.add(workspace_id, **kwargs) -> BetaServiceAccountWorkspaceMemberRequires 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
beta.organization.workspaces.service_accounts.retrieve(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMemberRequires 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
beta.organization.workspaces.service_accounts.update(service_account_id, **kwargs) -> BetaServiceAccountWorkspaceMemberRequires 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
beta.organization.workspaces.service_accounts.remove(service_account_id, **kwargs) -> ServiceAccountRemoveResponseRequires 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
beta.organization.rate_limits.list(**kwargs) -> SyncPageCursor[BetaOrganizationRateLimit]List Messages API rate limits for your organization.
OrganizationCompliance Settings
Get Compliance Settings
beta.organization.compliance_settings.retrieve() -> BetaComplianceSettingsRetrieve your organization's Compliance Settings.
Update Compliance Settings
beta.organization.compliance_settings.update(**kwargs) -> BetaComplianceSettingsUpdate your organization's Compliance Settings.
OrganizationAnalyticsSummaries
Get Activity Summaries
beta.organization.analytics.summaries.list(**kwargs) -> SyncPageCursor[BetaAnalyticsSingleDayActivitySummary]Get organization-wide activity summaries for a date range.
OrganizationAnalyticsUsers
List User Activity
beta.organization.analytics.users.list(**kwargs) -> SyncPageCursor[BetaAnalyticsUserActivity]Get per-user activity for a given day, with cursor-based pagination.
OrganizationAnalyticsAppsChatProjects
Get Chat Project Usage
beta.organization.analytics.apps.chat.projects.list(**kwargs) -> SyncPageCursor[BetaAnalyticsProjectActivity]Get per-project activity for a given day, with cursor-based pagination.
OrganizationAnalyticsConnectors
Get Connector Usage
beta.organization.analytics.connectors.list(**kwargs) -> SyncPageCursor[BetaAnalyticsConnectorActivity]Get per-connector usage for a given day, with cursor-based pagination.
OrganizationAnalyticsPlugins
Get Plugin Usage
beta.organization.analytics.plugins.list(**kwargs) -> SyncPageCursor[BetaAnalyticsPluginActivity]Get per-plugin install + invocation usage for a given day, with pagination.
OrganizationAnalyticsSkills
Get Skill Usage
beta.organization.analytics.skills.list(**kwargs) -> SyncPageCursor[BetaAnalyticsSkillActivity]Get per-skill usage for a given day, with cursor-based pagination.
OrganizationAnalyticsArtifacts
Get Artifact Activity
beta.organization.analytics.artifacts.list(**kwargs) -> SyncPageCursor[BetaAnalyticsArtifactActivity]Get artifact-creation activity for a given day, broken out by MIME type.
OrganizationAnalyticsUsage Report
Get Token Usage Over Time
beta.organization.analytics.usage_report.list(**kwargs) -> SyncPageCursor[BetaAnalyticsUsageReportTimeBucket]Get token usage over time across a date range.
OrganizationAnalyticsUser Usage Report
Get Per-User Token Usage
beta.organization.analytics.user_usage_report.list(**kwargs) -> SyncPageCursor[BetaAnalyticsUsageUsersItem]Get per-user token usage across a date range.
OrganizationAnalyticsCost Report
Get Cost Over Time
beta.organization.analytics.cost_report.list(**kwargs) -> SyncPageCursor[BetaAnalyticsCostReportTimeBucket]Get cost in USD over time across a date range.
OrganizationAnalyticsUser Cost Report
Get Per-User Cost
beta.organization.analytics.user_cost_report.list(**kwargs) -> SyncPageCursor[BetaAnalyticsCostUsersItem]Get per-user cost in USD across a date range.
OrganizationSpend Limits
Set Spend Limit
beta.organization.spend_limits.set(**kwargs) -> BetaSpendLimitSet a spend limit.
Get Spend Limit
beta.organization.spend_limits.retrieve(spend_limit_id) -> BetaSpendLimitRetrieve a spend limit by ID.
Delete Spend Limit
beta.organization.spend_limits.delete(spend_limit_id) -> SpendLimitDeleteResponseDelete a spend limit.
List Spend Limits
beta.organization.spend_limits.list(**kwargs) -> SyncPageCursor[BetaSpendLimit]List the organization's spend limits.
OrganizationSpend LimitsEffective
List Effective Spend Limits
beta.organization.spend_limits.effective.list(**kwargs) -> SyncPageCursor[BetaSpendSummary]List each member's effective spend limit and period-to-date spend.
OrganizationSpend LimitsIncrease Requests
List Spend Limit Increase Requests
beta.organization.spend_limits.increase_requests.list(**kwargs) -> SyncPageCursor[BetaSpendLimitIncreaseRequest]List spend limit increase requests, most recent first.
Get Spend Limit Increase Request
beta.organization.spend_limits.increase_requests.retrieve(spend_limit_increase_request_id) -> BetaSpendLimitIncreaseRequestRetrieve a spend limit increase request.
Approve Spend Limit Increase Request
beta.organization.spend_limits.increase_requests.approve(spend_limit_increase_request_id, **kwargs) -> IncreaseRequestApproveResponseApprove a pending spend limit increase request.
Deny Spend Limit Increase Request
beta.organization.spend_limits.increase_requests.deny(spend_limit_increase_request_id, **kwargs) -> BetaSpendLimitIncreaseRequestDeny a pending spend limit increase request.
OrganizationRBAC Groups
Create RBAC Group
beta.organization.rbac_groups.create(**kwargs) -> BetaRBACGroupCreate an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type "direct".
List RBAC Groups
beta.organization.rbac_groups.list(**kwargs) -> SyncPageCursor[BetaRBACGroup]List RBAC Groups in the Claude Enterprise tenant.
Get RBAC Group
beta.organization.rbac_groups.retrieve(rbac_group_id) -> BetaRBACGroupRetrieve an RBAC Group by ID.
Update RBAC Group
beta.organization.rbac_groups.update(rbac_group_id, **kwargs) -> BetaRBACGroupUpdate an RBAC Group's name. Groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
Delete RBAC Group
beta.organization.rbac_groups.delete(rbac_group_id) -> RBACGroupDeleteResponseDelete an RBAC Group. Groups provisioned by an identity provider (source type "scim") cannot be deleted via the API while an organization in the tenant uses SCIM provisioning.
OrganizationRBAC GroupsMembers
List RBAC Group Members
beta.organization.rbac_groups.members.list(rbac_group_id, **kwargs) -> SyncPageCursor[BetaRBACGroupMember]List members of an RBAC Group.
Add RBAC Group Member
beta.organization.rbac_groups.members.add(rbac_group_id, **kwargs) -> BetaRBACGroupMemberAdd a User to an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
Remove RBAC Group Member
beta.organization.rbac_groups.members.remove(user_id, **kwargs) -> MemberRemoveResponseRemove a User from an RBAC Group. Membership of groups provisioned by an identity provider (source type "scim") cannot be modified via the API while an organization in the tenant uses SCIM provisioning.
OrganizationRBAC Roles
List RBAC Roles
beta.organization.rbac_roles.list(**kwargs) -> SyncPageCursor[BetaRBACRole]List RBAC Roles in the organization.
Get RBAC Role
beta.organization.rbac_roles.retrieve(rbac_role_id) -> BetaRBACRoleRetrieve an RBAC Role by ID.
OrganizationRBAC RolesPermissions
List RBAC Role Permissions
beta.organization.rbac_roles.permissions.list(rbac_role_id, **kwargs) -> SyncPageCursor[BetaRBACRolePermission]List the permissions an RBAC Role grants.
OrganizationPlugins
Create Plugin
beta.organization.plugins.create(**kwargs) -> BetaPluginCreate an organization-owned Plugin and its first version by uploading the version's files.
Get Plugin
beta.organization.plugins.retrieve(plugin_id, **kwargs) -> BetaPluginRetrieve a Plugin by ID.
Update Plugin
beta.organization.plugins.update(plugin_id, **kwargs) -> BetaPluginChange which stored version of an organization-owned Plugin is served to members, for example to roll back to an earlier one. This pins the served version: later uploads are stored but no longer change what is served, and pinning cannot currently be undone, here or in claude.ai.
List Plugins
beta.organization.plugins.list(**kwargs) -> SyncPageCursor[BetaPlugin]List the Plugins created under the organization, newest first: those in the organization's own plugin marketplaces and those in members' personal plugin marketplaces.
Delete Plugin
beta.organization.plugins.delete(plugin_id, **kwargs) -> BetaDeletedPluginPermanently delete a Plugin and every version it holds, exactly as when an administrator deletes it in claude.ai. The Plugin may belong to the organization or to a member, including a member who has since left the organization.
OrganizationPluginsVersions
Create Plugin Version
beta.organization.plugins.versions.create(plugin_id, **kwargs) -> BetaPluginVersionAdd a version to an organization-owned Plugin by uploading the new version's files; it becomes the version served to members unless the Plugin's served version has been pinned.
List Plugin Versions
beta.organization.plugins.versions.list(plugin_id, **kwargs) -> SyncPageCursor[BetaPluginVersion]List a Plugin's versions, newest first.
Get Plugin Version
beta.organization.plugins.versions.retrieve(version, **kwargs) -> BetaPluginVersionRetrieve one version of a Plugin by its ID, or the Plugin's newest version.
Download Plugin Version Archive
beta.organization.plugins.versions.download(version, **kwargs) -> BinaryResponseContentDownload one version's .zip archive, exactly as stored. Each download of a
Plugin from a member's personal plugin marketplace is recorded on the Compliance API
activity feed.
OrganizationPluginsInstallation Settings
List Plugin Installation Settings
beta.organization.plugins.installation_settings.list(plugin_id, **kwargs) -> SyncPageCursor[BetaPluginInstallationSetting]List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.
Set Plugin Installation Setting
beta.organization.plugins.installation_settings.set(target, **kwargs) -> BetaPluginInstallationSettingSet or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.
Remove Plugin Installation Setting
beta.organization.plugins.installation_settings.remove(target, **kwargs) -> BetaDeletedPluginInstallationSettingRemove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.
OrganizationPlugin Marketplaces
List Plugin Marketplaces
beta.organization.plugin_marketplaces.list(**kwargs) -> SyncPageCursor[BetaPluginMarketplace]List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.
Get Plugin Marketplace
beta.organization.plugin_marketplaces.retrieve(marketplace_id, **kwargs) -> BetaPluginMarketplaceRetrieve a plugin marketplace by ID.
Update Plugin Marketplace
beta.organization.plugin_marketplaces.update(marketplace_id, **kwargs) -> BetaPluginMarketplaceSet the default installation setting of one of the organization's own plugin marketplaces. Every Plugin in it without a setting of its own gets this default as its organization-wide setting, including Plugins added later.
Validate Plugin Marketplace Repository
beta.organization.plugin_marketplaces.validate_repository(**kwargs) -> BetaPluginMarketplaceValidationReportCheck whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.
Validate Plugin Marketplace Archive
beta.organization.plugin_marketplaces.validate_archive(**kwargs) -> BetaPluginMarketplaceValidationReportCheck whether a plugin marketplace, uploaded as a .zip of the marketplace
directory, would synchronize into claude.ai, without connecting or storing it.