Claude Platform Docs

Organization

Get Current Organization
BetaOrganization Beta.Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

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

Models
class BetaOrganization { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum BetaOrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

OrganizationAPI Keys

List API Keys
ApiKeyListPage Beta.Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
Retrieve API Key (Admin API)
BetaApiKey Beta.Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
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
BetaApiKey Beta.Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

OrganizationExternal Keys

Create External Key
BetaExternalKey Beta.Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

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

List External Keys
ExternalKeyListPage Beta.Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

List external key configs in the caller's organization.

Get External Key
BetaExternalKey Beta.Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

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

Update External Key
BetaExternalKey Beta.Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

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

Delete External Key
ExternalKeyDeleteResponse Beta.Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

Delete an external key config.

Validate External Key
ExternalKeyValidateResponse Beta.Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

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

OrganizationFederationIssuers

Create Federation Issuer
BetaFederationIssuer Beta.Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
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
IssuerListPage Beta.Organization.Federation.Issuers.List(parameters, cancellationToken = default)
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
BetaFederationIssuer Beta.Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
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
BetaFederationIssuer Beta.Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
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
BetaFederationIssuer Beta.Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
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
BetaFederationRule Beta.Organization.Federation.Rules.Create(parameters, cancellationToken = default)
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
RuleListPage Beta.Organization.Federation.Rules.List(parameters, cancellationToken = default)
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
BetaFederationRule Beta.Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
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
BetaFederationRule Beta.Organization.Federation.Rules.Update(parameters, cancellationToken = default)
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
BetaFederationRule Beta.Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
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
BetaFederationRuleWorkspace Beta.Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
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
WorkspaceListPage Beta.Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
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
WorkspaceRemoveResponse Beta.Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
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
BetaOrganizationInvite Beta.Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

Invite a user to join the organization by email.

List Invites
InviteListPage Beta.Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

List the organization's invites.

Get Invite
BetaOrganizationInvite Beta.Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

Retrieve an invite by ID.

Delete Invite
InviteDeleteResponse Beta.Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

Delete a pending invite.

OrganizationService Accounts

Create Service Account
BetaServiceAccount Beta.Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
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
ServiceAccountListPage Beta.Organization.ServiceAccounts.List(parameters, cancellationToken = default)
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
BetaServiceAccount Beta.Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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
BetaServiceAccount Beta.Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
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
BetaServiceAccount Beta.Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
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
BetaServiceAccountWorkspaceMember Beta.Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
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
WorkspaceListPage Beta.Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
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
WorkspaceRemoveResponse Beta.Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
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
UserListPage Beta.Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

List the organization's members.

Get User
BetaOrganizationUser Beta.Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

Retrieve a member of the organization by user ID.

Update User
BetaOrganizationUser Beta.Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

Update a member's organization role.

Remove User
UserRemoveResponse Beta.Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

Remove a member from the organization.

OrganizationWorkspaces

List Workspaces
WorkspaceListPage Beta.Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Create Workspace
BetaWorkspace Beta.Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Get Workspace
BetaWorkspace Beta.Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Update Workspace
BetaWorkspace Beta.Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Archive Workspace
BetaWorkspace Beta.Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizationWorkspacesRate Limits

List Workspace Rate Limits
RateLimitListPage Beta.Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

List a workspace's rate limits.

Set Workspace Rate Limits
BetaWorkspaceRateLimit Beta.Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Set or clear rate-limit overrides for one rate-limit group in a workspace.

OrganizationWorkspacesMembers

List Workspace Members
MemberListPage Beta.Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Create Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Get Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Update Workspace Member
BetaWorkspaceMember Beta.Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Delete Workspace Member
MemberRemoveResponse Beta.Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizationWorkspacesService Accounts

List Service Account Workspace Members
ServiceAccountListPage Beta.Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
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
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
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
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
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
BetaServiceAccountWorkspaceMember Beta.Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
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
ServiceAccountRemoveResponse Beta.Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
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
RateLimitListPage Beta.Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

List Messages API rate limits for your organization.

OrganizationCompliance Settings

Get Compliance Settings
BetaComplianceSettings Beta.Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

Retrieve your organization's Compliance Settings.

Update Compliance Settings
BetaComplianceSettings Beta.Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.

OrganizationAnalyticsSummaries

Get Activity Summaries
SummaryListPage Beta.Organization.Analytics.Summaries.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/summaries

Get organization-wide activity summaries for a date range.

OrganizationAnalyticsUsers

List User Activity
UserListPage Beta.Organization.Analytics.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/users

Get per-user activity for a given day, with cursor-based pagination.

OrganizationAnalyticsAppsChatProjects

Get Chat Project Usage
ProjectListPage Beta.Organization.Analytics.Apps.Chat.Projects.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/apps/chat/projects

Get per-project activity for a given day, with cursor-based pagination.

OrganizationAnalyticsConnectors

Get Connector Usage
ConnectorListPage Beta.Organization.Analytics.Connectors.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/connectors

Get per-connector usage for a given day, with cursor-based pagination.

OrganizationAnalyticsPlugins

Get Plugin Usage
PluginListPage Beta.Organization.Analytics.Plugins.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/plugins

Get per-plugin install + invocation usage for a given day, with pagination.

OrganizationAnalyticsSkills

Get Skill Usage
SkillListPage Beta.Organization.Analytics.Skills.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/skills

Get per-skill usage for a given day, with cursor-based pagination.

OrganizationAnalyticsArtifacts

Get Artifact Activity
ArtifactListPage Beta.Organization.Analytics.Artifacts.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/artifacts

Get artifact-creation activity for a given day, broken out by MIME type.

OrganizationAnalyticsUsage

Get Token Usage By Dimension
UsageListPage Beta.Organization.Analytics.Usage.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/usage

Get token usage across a date range, broken out by dimension.

OrganizationAnalyticsCost

Get Cost By Dimension
CostListPage Beta.Organization.Analytics.Cost.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/cost

Get cost in USD across a date range, broken out by dimension.

OrganizationAnalyticsUsage Report

Get Token Usage Over Time
UsageReportListPage Beta.Organization.Analytics.UsageReport.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/usage_report

[Legacy] Get token usage over time across a date range.

OrganizationAnalyticsUser Usage Report

Get Per-User Token Usage
UserUsageReportListPage Beta.Organization.Analytics.UserUsageReport.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/user_usage_report

[Legacy] Get per-user token usage across a date range.

OrganizationAnalyticsCost Report

Get Cost Over Time
CostReportListPage Beta.Organization.Analytics.CostReport.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/cost_report

[Legacy] Get cost in USD over time across a date range.

OrganizationAnalyticsUser Cost Report

Get Per-User Cost
UserCostReportListPage Beta.Organization.Analytics.UserCostReport.List(parameters, cancellationToken = default)
GET/v1/organizations/analytics/user_cost_report

[Legacy] Get per-user cost in USD across a date range.

OrganizationSpend Limits

Set Spend Limit
BetaSpendLimit Beta.Organization.SpendLimits.Set(parameters, cancellationToken = default)
POST/v1/organizations/spend_limits

Set a spend limit.

Get Spend Limit
BetaSpendLimit Beta.Organization.SpendLimits.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/spend_limits/{spend_limit_id}

Retrieve a spend limit by ID.

Delete Spend Limit
SpendLimitDeleteResponse Beta.Organization.SpendLimits.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/spend_limits/{spend_limit_id}

Delete a spend limit.

List Spend Limits
SpendLimitListPage Beta.Organization.SpendLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/spend_limits

List the organization's spend limits.

OrganizationSpend LimitsEffective

List Effective Spend Limits
EffectiveListPage Beta.Organization.SpendLimits.Effective.List(parameters, cancellationToken = default)
GET/v1/organizations/spend_limits/effective

List each member's effective spend limit and period-to-date spend.

OrganizationSpend LimitsIncrease Requests

List Spend Limit Increase Requests
IncreaseRequestListPage Beta.Organization.SpendLimits.IncreaseRequests.List(parameters, cancellationToken = default)
GET/v1/organizations/spend_limit_increase_requests

List spend limit increase requests, most recent first.

Get Spend Limit Increase Request
BetaSpendLimitIncreaseRequest Beta.Organization.SpendLimits.IncreaseRequests.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}

Retrieve a spend limit increase request.

Approve Spend Limit Increase Request
IncreaseRequestApproveResponse Beta.Organization.SpendLimits.IncreaseRequests.Approve(parameters, cancellationToken = default)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/approve

Approve a pending spend limit increase request.

Deny Spend Limit Increase Request
BetaSpendLimitIncreaseRequest Beta.Organization.SpendLimits.IncreaseRequests.Deny(parameters, cancellationToken = default)
POST/v1/organizations/spend_limit_increase_requests/{spend_limit_increase_request_id}/deny

Deny a pending spend limit increase request.

OrganizationRBAC Groups

Create RBAC Group
BetaRbacGroup Beta.Organization.RbacGroups.Create(parameters, cancellationToken = default)
POST/v1/organizations/rbac_groups

Create an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type "direct".

List RBAC Groups
RbacGroupListPage Beta.Organization.RbacGroups.List(parameters, cancellationToken = default)
GET/v1/organizations/rbac_groups

List RBAC Groups in the Claude Enterprise tenant.

Get RBAC Group
BetaRbacGroup Beta.Organization.RbacGroups.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/rbac_groups/{rbac_group_id}

Retrieve an RBAC Group by ID.

Update RBAC Group
BetaRbacGroup Beta.Organization.RbacGroups.Update(parameters, cancellationToken = default)
POST/v1/organizations/rbac_groups/{rbac_group_id}

Update 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
RbacGroupDeleteResponse Beta.Organization.RbacGroups.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/rbac_groups/{rbac_group_id}

Delete 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
MemberListPage Beta.Organization.RbacGroups.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/rbac_groups/{rbac_group_id}/members

List members of an RBAC Group.

Add RBAC Group Member
BetaRbacGroupMember Beta.Organization.RbacGroups.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/rbac_groups/{rbac_group_id}/members

Add 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
MemberRemoveResponse Beta.Organization.RbacGroups.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/rbac_groups/{rbac_group_id}/members/{user_id}

Remove 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
RbacRoleListPage Beta.Organization.RbacRoles.List(parameters, cancellationToken = default)
GET/v1/organizations/rbac_roles

List RBAC Roles in the organization.

Get RBAC Role
BetaRbacRole Beta.Organization.RbacRoles.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/rbac_roles/{rbac_role_id}

Retrieve an RBAC Role by ID.

OrganizationRBAC RolesPermissions

List RBAC Role Permissions
PermissionListPage Beta.Organization.RbacRoles.Permissions.List(parameters, cancellationToken = default)
GET/v1/organizations/rbac_roles/{rbac_role_id}/permissions

List the permissions an RBAC Role grants.

OrganizationPlugins

Create Plugin
BetaPlugin Beta.Organization.Plugins.Create(parameters, cancellationToken = default)
POST/v1/organizations/plugins

Create an organization-owned Plugin and its first version by uploading the version's files.

Get Plugin
BetaPlugin Beta.Organization.Plugins.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}

Retrieve a Plugin by ID.

Update Plugin
BetaPlugin Beta.Organization.Plugins.Update(parameters, cancellationToken = default)
POST/v1/organizations/plugins/{plugin_id}

Change 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
PluginListPage Beta.Organization.Plugins.List(parameters, cancellationToken = default)
GET/v1/organizations/plugins

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
BetaDeletedPlugin Beta.Organization.Plugins.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/plugins/{plugin_id}

Permanently 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
BetaPluginVersion Beta.Organization.Plugins.Versions.Create(parameters, cancellationToken = default)
POST/v1/organizations/plugins/{plugin_id}/versions

Add 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
VersionListPage Beta.Organization.Plugins.Versions.List(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}/versions

List a Plugin's versions, newest first.

Get Plugin Version
BetaPluginVersion Beta.Organization.Plugins.Versions.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}/versions/{version}

Retrieve one version of a Plugin by its ID, or the Plugin's newest version.

Download Plugin Version Archive
HttpResponse Beta.Organization.Plugins.Versions.Download(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}/versions/{version}/content

Download 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
InstallationSettingListPage Beta.Organization.Plugins.InstallationSettings.List(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}/installation_settings

List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.

Set Plugin Installation Setting
BetaPluginInstallationSetting Beta.Organization.Plugins.InstallationSettings.Set(parameters, cancellationToken = default)
POST/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Set or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.

Remove Plugin Installation Setting
BetaDeletedPluginInstallationSetting Beta.Organization.Plugins.InstallationSettings.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/plugins/{plugin_id}/installation_settings/{target}

Remove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.

OrganizationPluginsShares

List Plugin Shares
ShareListPage Beta.Organization.Plugins.Shares.List(parameters, cancellationToken = default)
GET/v1/organizations/plugins/{plugin_id}/shares

List the shares the owner of a member-owned Plugin has given — to every member of the organization, to an RBAC Group, or to one member — most recently granted first.

OrganizationPlugin Marketplaces

List Plugin Marketplaces
PluginMarketplaceListPage Beta.Organization.PluginMarketplaces.List(parameters, cancellationToken = default)
GET/v1/organizations/plugin_marketplaces

List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.

Get Plugin Marketplace
BetaPluginMarketplace Beta.Organization.PluginMarketplaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/plugin_marketplaces/{marketplace_id}

Retrieve a plugin marketplace by ID.

Update Plugin Marketplace
BetaPluginMarketplace Beta.Organization.PluginMarketplaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/plugin_marketplaces/{marketplace_id}

Set 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
BetaPluginMarketplaceValidationReport Beta.Organization.PluginMarketplaces.ValidateRepository(parameters, cancellationToken = default)
POST/v1/organizations/plugin_marketplaces/validate_repository

Check whether a plugin marketplace held in a public GitHub repository would synchronize into claude.ai, without connecting or storing it.

Validate Plugin Marketplace Archive
BetaPluginMarketplaceValidationReport Beta.Organization.PluginMarketplaces.ValidateArchive(parameters, cancellationToken = default)
POST/v1/organizations/plugin_marketplaces/validate_archive

Check whether a plugin marketplace, uploaded as a .zip of the marketplace directory, would synchronize into claude.ai, without connecting or storing it.

OrganizationTelemetry Destinations

Create a Telemetry Destination
BetaTelemetryDestination Beta.Organization.TelemetryDestinations.Create(parameters, cancellationToken = default)
POST/v1/organizations/telemetry_destinations

Register an OpenTelemetry destination for the organization.

List Telemetry Destinations
TelemetryDestinationListPage Beta.Organization.TelemetryDestinations.List(parameters, cancellationToken = default)
GET/v1/organizations/telemetry_destinations

List the organization's destinations, newest first, optionally only those that cover given workspaces.

Retrieve a Telemetry Destination
BetaTelemetryDestination Beta.Organization.TelemetryDestinations.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/telemetry_destinations/{destination_id}

Read a destination's configuration, state, and most recent delivery results.

Update a Telemetry Destination
BetaTelemetryDestination Beta.Organization.TelemetryDestinations.Update(parameters, cancellationToken = default)
POST/v1/organizations/telemetry_destinations/{destination_id}

Change a telemetry destination's settings, its state, or which workspaces it covers.

Delete a Telemetry Destination
BetaDeletedTelemetryDestination Beta.Organization.TelemetryDestinations.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/telemetry_destinations/{destination_id}

Delete a destination and its workspace list.

Test a Telemetry Destination
BetaTelemetryDestinationTestResponse Beta.Organization.TelemetryDestinations.Test(parameters, cancellationToken = default)
POST/v1/organizations/telemetry_destinations/{destination_id}/test

Send one test span, named anthropic.test, to the destination with its registered headers, once and without retries, and report the destination's answer. The response is 200 whether or not the destination answered with a 2xx status: its result has the type success, or the type failure and the reason in error. The destination's configuration, state and delivery_health do not change. A disabled destination can be tested too. Wait 10 seconds between tests of one destination; a request that comes sooner may be answered with status 429.

OrganizationTelemetry DestinationsWorkspaces

List Telemetry Destination Workspaces
WorkspaceListPage Beta.Organization.TelemetryDestinations.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/telemetry_destinations/{destination_id}/workspaces

List the workspaces on a destination's workspace list, newest entry first.

Add a Telemetry Destination Workspace
BetaTelemetryDestinationWorkspace Beta.Organization.TelemetryDestinations.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Add one workspace to a destination's workspace list.

Remove a Telemetry Destination Workspace
BetaDeletedTelemetryDestinationWorkspace Beta.Organization.TelemetryDestinations.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/telemetry_destinations/{destination_id}/workspaces/{workspace_id}

Remove one workspace from a destination's workspace list.

OrganizationWebhooks

Create Organization Webhook Endpoint
BetaNewOrganizationWebhookEndpoint Beta.Organization.Webhooks.Create(parameters, cancellationToken = default)
POST/v1/organizations/webhooks

Create an organization webhook endpoint.

List Organization Webhook Endpoints
WebhookListPage Beta.Organization.Webhooks.List(parameters, cancellationToken = default)
GET/v1/organizations/webhooks

List the organization's webhook endpoints.

Get Organization Webhook Endpoint
BetaOrganizationWebhookEndpoint Beta.Organization.Webhooks.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/webhooks/{webhook_endpoint_id}

Retrieve an organization webhook endpoint by ID.

Update Organization Webhook Endpoint
BetaOrganizationWebhookEndpoint Beta.Organization.Webhooks.Update(parameters, cancellationToken = default)
POST/v1/organizations/webhooks/{webhook_endpoint_id}

Update an organization webhook endpoint. Only the fields you send are changed.

Delete Organization Webhook Endpoint
BetaDeletedOrganizationWebhookEndpoint Beta.Organization.Webhooks.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/webhooks/{webhook_endpoint_id}

Delete an organization webhook endpoint.

Regenerate Organization Webhook Endpoint Signing Secret
BetaOrganizationWebhookEndpointSigningSecret Beta.Organization.Webhooks.RegenerateSigningSecret(parameters, cancellationToken = default)
POST/v1/organizations/webhooks/{webhook_endpoint_id}/regenerate_signing_secret

Replace an organization webhook endpoint's signing secret. The old secret stops working immediately. The new secret is returned only in this response.

OrganizationClaude TagSlack Channels

Set Up Slack Channel
BetaClaudeTagSlackChannel Beta.Organization.ClaudeTag.SlackChannels.Create(parameters, cancellationToken = default)
POST/v1/organizations/claude_tag/slack_channels

Set a Slack channel up for Claude Tag and return it with its identifier. If the channel is already set up, whether in claude.ai, by Claude's first use in it or by an earlier request, the existing channel is returned, so the request can be repeated. settings, when sent, is applied as an update applies it. Before a channel is set up, Claude's Slack app confirms with Slack that the channel is in the workspace, is not archived and is visible to the app; a channel that fails the confirmation returns 404. Setting the channel up and applying settings are two steps: when the second is refused, the response is the refusal, the channel stays set up with every setting unset, and the error's details.slack_channel_id holds the channel's identifier.

List Slack Channels
SlackChannelListPage Beta.Organization.ClaudeTag.SlackChannels.List(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/slack_channels

List the set-up Slack channels of one Slack workspace, newest first by created_at. A channel that is not set up is not listed: Slack holds the full list of a workspace's channels. Pass slack_channel_id as well to look one channel up by its Slack identifiers: data then holds that channel, or is empty when it is not set up, and limit and page are ignored. A workspace that the organization owns only through a Slack Enterprise Grid returns 404 until it is set up. With include_inherited=true each channel's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Channel
BetaClaudeTagSlackChannel Beta.Organization.ClaudeTag.SlackChannels.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/slack_channels/{id}

Get one Slack channel and its settings. By default settings holds what the channel itself stores: a setting that is null there is not set on the channel and is inherited. With include_inherited=true, settings holds what applies in the channel once the settings levels above it are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from, so a caller tells the channel's own value from an inherited one by its source, not by whether it is null.

Update Slack Channel
BetaClaudeTagSlackChannel Beta.Organization.ClaudeTag.SlackChannels.Update(parameters, cancellationToken = default)
POST/v1/organizations/claude_tag/slack_channels/{id}

Change the settings a Slack channel stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the channel inherits it. If any value is refused, no setting in the request is stored. A group direct message takes no settings and returns 400.

Remove Slack Channel
BetaClaudeTagDeletedSlackChannel Beta.Organization.ClaudeTag.SlackChannels.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/claude_tag/slack_channels/{id}

Remove a Slack channel from Claude Tag. This deletes the channel's stored settings and its Bundle Targets at once, and then, in the background, the channel's sessions and their transcripts, its memory, its routines and the artifacts published from it. None of it can be restored. The channel in Slack and its messages are unchanged. The request is refused with 400 and error.details.error_code slack_channel_enabled while enabled resolves to true for the channel, as a read with include_inherited=true returns it: set enabled to false on the channel first. This guards against removing a channel in use by mistake; it is not a way to keep Claude out, because the removal deletes the channel's own enabled: false with its other settings, after which the channel inherits again and Claude's next use of it can set it up anew with a new identifier. The identifier returns 404 as soon as the request returns, so a repeated removal returns 404. A group direct message returns 400, and so does a channel that holds configuration this API does not manage.

OrganizationClaude TagSlack Workspaces

List Slack Workspaces
SlackWorkspaceListPage Beta.Organization.ClaudeTag.SlackWorkspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/slack_workspaces

List the set-up Slack workspaces the organization owns, newest first by created_at. Pass slack_workspace_id to look one workspace up by its Slack identifier: data then holds that workspace, or is empty when it is not set up. A workspace of a Slack Enterprise Grid the organization has connected returns 404 until it is set up. With include_inherited=true each workspace's settings holds what applies in it, and the request fails with 503 rather than resolve against a settings level that could not be read. A page cursor resumes only a request with the same include_inherited.

Get Slack Workspace
BetaClaudeTagSlackWorkspace Beta.Organization.ClaudeTag.SlackWorkspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/slack_workspaces/{id}

Get one Slack workspace and its settings. By default settings holds what the workspace itself stores: a setting that is null there is not set on the workspace and is inherited. With include_inherited=true, settings holds what applies in the workspace once the organization's Slack defaults are taken into account, and the request fails with 503 rather than resolve against a settings level that could not be read. Either way sources names the settings level each value comes from.

Update Slack Workspace
BetaClaudeTagSlackWorkspace Beta.Organization.ClaudeTag.SlackWorkspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/claude_tag/slack_workspaces/{id}

Change the settings a Slack workspace stores. The update is partial: a setting left out is unchanged, and a setting sent as null is cleared, so the workspace inherits it. If any value is refused, no setting in the request is stored.

OrganizationClaude TagBundles

List Bundles
BundleListPage Beta.Organization.ClaudeTag.Bundles.List(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/bundles

List the organization's Bundles, newest first by created_at. A Bundle that Claude Tag manages for itself is not listed.

Get Bundle
BetaClaudeTagBundle Beta.Organization.ClaudeTag.Bundles.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/bundles/{bundle_id}

Get one Bundle. What the Bundle grants (connectors, repositories and credentials) is never returned.

OrganizationClaude TagBundlesTargets

List Bundle Targets
TargetListPage Beta.Organization.ClaudeTag.Bundles.Targets.List(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets

List the Slack channels and Slack workspaces a Bundle is attached to, newest first by created_at. Only channels and workspaces the organization owns are listed; a Bundle that is attached to anything else has no Bundle Target for it.

Attach Bundle
BetaClaudeTagBundleTarget Beta.Organization.ClaudeTag.Bundles.Targets.Create(parameters, cancellationToken = default)
POST/v1/organizations/claude_tag/bundles/{bundle_id}/targets

Attach a Bundle to a Slack channel or a Slack workspace. A Bundle attached to a workspace can be used in the workspace and in every channel in it. Attaching a Bundle to a channel or workspace it is already attached to returns the existing Bundle Target. The channel or workspace must be set up: attaching never sets a channel up. A group direct message takes no Bundle and returns 400.

Get Bundle Target
BetaClaudeTagBundleTarget Beta.Organization.ClaudeTag.Bundles.Targets.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}

Get one Bundle Target. Returns 404 when target_id is the identifier of another Bundle's Bundle Target, or the Bundle Target was detached.

Detach Bundle
BetaClaudeTagDeletedBundleTarget Beta.Organization.ClaudeTag.Bundles.Targets.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/claude_tag/bundles/{bundle_id}/targets/{target_id}

Detach a Bundle from a Slack channel or a Slack workspace. A repeated detach returns 404.