Organization
Get Current Organization
client.beta.organization.retrieve(options?): BetaOrganizationRetrieve information about the organization associated with the authenticated API key.
Models
OrganizationAPI Keys
List API Keys
client.beta.organization.apiKeys.list(query?, options?): Page<BetaAPIKey>Retrieve API Key (Admin API)
client.beta.organization.apiKeys.retrieve(apiKeyID, options?): 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
client.beta.organization.apiKeys.update(apiKeyID, body, options?): BetaAPIKeyOrganizationExternal Keys
Create External Key
client.beta.organization.externalKeys.create(body, options?): BetaExternalKeyCreate an external key config owned by the caller's organization.
List External Keys
client.beta.organization.externalKeys.list(query?, options?): PageCursor<BetaExternalKey>List external key configs in the caller's organization.
Get External Key
client.beta.organization.externalKeys.retrieve(externalKeyID, options?): BetaExternalKeyRetrieve a single external key config in the caller's organization by ID.
Update External Key
client.beta.organization.externalKeys.update(externalKeyID, body, options?): BetaExternalKeyPartially update an external key config. Omitted fields are left unchanged.
Delete External Key
client.beta.organization.externalKeys.delete(externalKeyID, options?): ExternalKeyDeleteResponseDelete an external key config.
Validate External Key
client.beta.organization.externalKeys.validate(externalKeyID, options?): ExternalKeyValidateResponseValidate an external key config against the customer's KMS.
OrganizationFederationIssuers
Create Federation Issuer
client.beta.organization.federation.issuers.create(params, options?): 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
client.beta.organization.federation.issuers.list(params?, options?): PageCursor<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
client.beta.organization.federation.issuers.retrieve(federationIssuerID, params?, options?): 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
client.beta.organization.federation.issuers.update(federationIssuerID, params, options?): 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
client.beta.organization.federation.issuers.archive(federationIssuerID, params?, options?): 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
client.beta.organization.federation.rules.create(params, options?): 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
client.beta.organization.federation.rules.list(params?, options?): PageCursor<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
client.beta.organization.federation.rules.retrieve(federationRuleID, params?, options?): 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
client.beta.organization.federation.rules.update(federationRuleID, params, options?): 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
client.beta.organization.federation.rules.archive(federationRuleID, params?, options?): 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
client.beta.organization.federation.rules.workspaces.add(federationRuleID, params, options?): 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
client.beta.organization.federation.rules.workspaces.list(federationRuleID, params?, options?): PageCursor<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
client.beta.organization.federation.rules.workspaces.remove(workspaceID, params, options?): 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
client.beta.organization.invites.create(body, options?): BetaOrganizationInviteInvite a user to join the organization by email.
List Invites
client.beta.organization.invites.list(query?, options?): Page<BetaOrganizationInvite>List the organization's invites.
Get Invite
client.beta.organization.invites.retrieve(inviteID, options?): BetaOrganizationInviteRetrieve an invite by ID.
Delete Invite
client.beta.organization.invites.delete(inviteID, options?): InviteDeleteResponseDelete a pending invite.
OrganizationService Accounts
Create Service Account
client.beta.organization.serviceAccounts.create(params, options?): 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
client.beta.organization.serviceAccounts.list(params?, options?): PageCursor<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
client.beta.organization.serviceAccounts.retrieve(serviceAccountID, params?, options?): 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
client.beta.organization.serviceAccounts.update(serviceAccountID, params, options?): 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
client.beta.organization.serviceAccounts.archive(serviceAccountID, params?, options?): 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
client.beta.organization.serviceAccounts.workspaces.add(serviceAccountID, params, options?): 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
client.beta.organization.serviceAccounts.workspaces.list(serviceAccountID, params?, options?): PageCursor<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
client.beta.organization.serviceAccounts.workspaces.remove(workspaceID, params, options?): 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
client.beta.organization.users.list(query?, options?): Page<BetaOrganizationUser>List the organization's members.
Get User
client.beta.organization.users.retrieve(userID, options?): BetaOrganizationUserRetrieve a member of the organization by user ID.
Update User
client.beta.organization.users.update(userID, body, options?): BetaOrganizationUserUpdate a member's organization role.
Remove User
client.beta.organization.users.remove(userID, options?): UserRemoveResponseRemove a member from the organization.
OrganizationWorkspaces
List Workspaces
client.beta.organization.workspaces.list(query?, options?): Page<BetaWorkspace>Create Workspace
client.beta.organization.workspaces.create(params, options?): BetaWorkspaceGet Workspace
client.beta.organization.workspaces.retrieve(workspaceID, options?): BetaWorkspaceUpdate Workspace
client.beta.organization.workspaces.update(workspaceID, body, options?): BetaWorkspaceArchive Workspace
client.beta.organization.workspaces.archive(workspaceID, options?): BetaWorkspaceOrganizationWorkspacesRate Limits
List Workspace Rate Limits
client.beta.organization.workspaces.rateLimits.list(workspaceID, query?, options?): PageCursor<BetaWorkspaceRateLimit>List a workspace's rate limits.
OrganizationWorkspacesMembers
List Workspace Members
client.beta.organization.workspaces.members.list(workspaceID, query?, options?): Page<BetaWorkspaceMember>Create Workspace Member
client.beta.organization.workspaces.members.add(workspaceID, body, options?): BetaWorkspaceMemberGet Workspace Member
client.beta.organization.workspaces.members.retrieve(userID, params, options?): BetaWorkspaceMemberUpdate Workspace Member
client.beta.organization.workspaces.members.update(userID, params, options?): BetaWorkspaceMemberDelete Workspace Member
client.beta.organization.workspaces.members.remove(userID, params, options?): MemberRemoveResponseOrganizationWorkspacesService Accounts
List Service Account Workspace Members
client.beta.organization.workspaces.serviceAccounts.list(workspaceID, params?, options?): PageCursor<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
client.beta.organization.workspaces.serviceAccounts.add(workspaceID, params, options?): 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
client.beta.organization.workspaces.serviceAccounts.retrieve(serviceAccountID, params, options?): 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
client.beta.organization.workspaces.serviceAccounts.update(serviceAccountID, params, options?): 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
client.beta.organization.workspaces.serviceAccounts.remove(serviceAccountID, params, options?): 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
client.beta.organization.rateLimits.list(query?, options?): PageCursor<BetaOrganizationRateLimit>List Messages API rate limits for your organization.
OrganizationCompliance Settings
Get Compliance Settings
client.beta.organization.complianceSettings.retrieve(options?): BetaComplianceSettingsRetrieve your organization's Compliance Settings.
Update Compliance Settings
client.beta.organization.complianceSettings.update(body, options?): BetaComplianceSettingsUpdate your organization's Compliance Settings.
OrganizationAnalyticsSummaries
Get Activity Summaries
client.beta.organization.analytics.summaries.list(query, options?): PageCursor<BetaAnalyticsSingleDayActivitySummary>Get organization-wide activity summaries for a date range.
OrganizationAnalyticsUsers
List User Activity
client.beta.organization.analytics.users.list(query?, options?): PageCursor<BetaAnalyticsUserActivity>Get per-user activity for a given day, with cursor-based pagination.
OrganizationAnalyticsAppsChatProjects
Get Chat Project Usage
client.beta.organization.analytics.apps.chat.projects.list(query?, options?): PageCursor<BetaAnalyticsProjectActivity>Get per-project activity for a given day, with cursor-based pagination.
OrganizationAnalyticsConnectors
Get Connector Usage
client.beta.organization.analytics.connectors.list(query?, options?): PageCursor<BetaAnalyticsConnectorActivity>Get per-connector usage for a given day, with cursor-based pagination.
OrganizationAnalyticsPlugins
Get Plugin Usage
client.beta.organization.analytics.plugins.list(query?, options?): PageCursor<BetaAnalyticsPluginActivity>Get per-plugin install + invocation usage for a given day, with pagination.
OrganizationAnalyticsSkills
Get Skill Usage
client.beta.organization.analytics.skills.list(query?, options?): PageCursor<BetaAnalyticsSkillActivity>Get per-skill usage for a given day, with cursor-based pagination.
OrganizationAnalyticsArtifacts
Get Artifact Activity
client.beta.organization.analytics.artifacts.list(query, options?): PageCursor<BetaAnalyticsArtifactActivity>Get artifact-creation activity for a given day, broken out by MIME type.
OrganizationAnalyticsUsage Report
Get Token Usage Over Time
client.beta.organization.analytics.usageReport.list(query, options?): PageCursor<BetaAnalyticsUsageReportTimeBucket>Get token usage over time across a date range.
OrganizationAnalyticsUser Usage Report
Get Per-User Token Usage
client.beta.organization.analytics.userUsageReport.list(query, options?): PageCursor<BetaAnalyticsUsageUsersItem>Get per-user token usage across a date range.
OrganizationAnalyticsCost Report
Get Cost Over Time
client.beta.organization.analytics.costReport.list(query, options?): PageCursor<BetaAnalyticsCostReportTimeBucket>Get cost in USD over time across a date range.
OrganizationAnalyticsUser Cost Report
Get Per-User Cost
client.beta.organization.analytics.userCostReport.list(query, options?): PageCursor<BetaAnalyticsCostUsersItem>Get per-user cost in USD across a date range.
OrganizationSpend Limits
Set Spend Limit
client.beta.organization.spendLimits.set(params, options?): BetaSpendLimitSet a spend limit.
Get Spend Limit
client.beta.organization.spendLimits.retrieve(spendLimitID, options?): BetaSpendLimitRetrieve a spend limit by ID.
Delete Spend Limit
client.beta.organization.spendLimits.delete(spendLimitID, options?): SpendLimitDeleteResponseDelete a spend limit.
List Spend Limits
client.beta.organization.spendLimits.list(params?, options?): PageCursor<BetaSpendLimit>List the organization's spend limits.
OrganizationSpend LimitsEffective
List Effective Spend Limits
client.beta.organization.spendLimits.effective.list(query?, options?): PageCursor<BetaSpendSummary>List each member's effective spend limit and period-to-date spend.
OrganizationSpend LimitsIncrease Requests
List Spend Limit Increase Requests
client.beta.organization.spendLimits.increaseRequests.list(query?, options?): PageCursor<BetaSpendLimitIncreaseRequest>List spend limit increase requests, most recent first.
Get Spend Limit Increase Request
client.beta.organization.spendLimits.increaseRequests.retrieve(spendLimitIncreaseRequestID, options?): BetaSpendLimitIncreaseRequestRetrieve a spend limit increase request.
Approve Spend Limit Increase Request
client.beta.organization.spendLimits.increaseRequests.approve(spendLimitIncreaseRequestID, body, options?): IncreaseRequestApproveResponseApprove a pending spend limit increase request.
Deny Spend Limit Increase Request
client.beta.organization.spendLimits.increaseRequests.deny(spendLimitIncreaseRequestID, body, options?): BetaSpendLimitIncreaseRequestDeny a pending spend limit increase request.
OrganizationRBAC Groups
Create RBAC Group
client.beta.organization.rbacGroups.create(body, options?): BetaRBACGroupCreate an RBAC Group in the Claude Enterprise tenant. Groups created via the API have source type "direct".
List RBAC Groups
client.beta.organization.rbacGroups.list(query?, options?): PageCursor<BetaRBACGroup>List RBAC Groups in the Claude Enterprise tenant.
Get RBAC Group
client.beta.organization.rbacGroups.retrieve(rbacGroupID, options?): BetaRBACGroupRetrieve an RBAC Group by ID.
Update RBAC Group
client.beta.organization.rbacGroups.update(rbacGroupID, body, options?): 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
client.beta.organization.rbacGroups.delete(rbacGroupID, options?): 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
client.beta.organization.rbacGroups.members.list(rbacGroupID, query?, options?): PageCursor<BetaRBACGroupMember>List members of an RBAC Group.
Add RBAC Group Member
client.beta.organization.rbacGroups.members.add(rbacGroupID, body, options?): 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
client.beta.organization.rbacGroups.members.remove(userID, params, options?): 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
client.beta.organization.rbacRoles.list(query?, options?): PageCursor<BetaRBACRole>List RBAC Roles in the organization.
Get RBAC Role
client.beta.organization.rbacRoles.retrieve(rbacRoleID, options?): BetaRBACRoleRetrieve an RBAC Role by ID.
OrganizationRBAC RolesPermissions
List RBAC Role Permissions
client.beta.organization.rbacRoles.permissions.list(rbacRoleID, query?, options?): PageCursor<BetaRBACRolePermission>List the permissions an RBAC Role grants.
OrganizationPlugins
Create Plugin
client.beta.organization.plugins.create(params, options?): BetaPluginCreate an organization-owned Plugin and its first version by uploading the version's files.
Get Plugin
client.beta.organization.plugins.retrieve(pluginID, params?, options?): BetaPluginRetrieve a Plugin by ID.
Update Plugin
client.beta.organization.plugins.update(pluginID, params, options?): 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
client.beta.organization.plugins.list(params?, options?): PageCursor<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
client.beta.organization.plugins.delete(pluginID, params?, options?): 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
client.beta.organization.plugins.versions.create(pluginID, params, options?): 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
client.beta.organization.plugins.versions.list(pluginID, params?, options?): PageCursor<BetaPluginVersion>List a Plugin's versions, newest first.
Get Plugin Version
client.beta.organization.plugins.versions.retrieve(version, params, options?): BetaPluginVersionRetrieve one version of a Plugin by its ID, or the Plugin's newest version.
Download Plugin Version Archive
client.beta.organization.plugins.versions.download(version, params, options?): ResponseDownload 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
client.beta.organization.plugins.installationSettings.list(pluginID, params?, options?): PageCursor<BetaPluginInstallationSetting>List an organization-owned Plugin's installation settings, which say which members it is for, most recently created first.
Set Plugin Installation Setting
client.beta.organization.plugins.installationSettings.set(target, params, options?): BetaPluginInstallationSettingSet or change an organization-owned Plugin's installation setting for the whole organization or for one RBAC Group.
Remove Plugin Installation Setting
client.beta.organization.plugins.installationSettings.remove(target, params, options?): BetaDeletedPluginInstallationSettingRemove an organization-owned Plugin's own installation setting for the whole organization or for one RBAC Group.
OrganizationPlugin Marketplaces
List Plugin Marketplaces
client.beta.organization.pluginMarketplaces.list(params?, options?): PageCursor<BetaPluginMarketplace>List the plugin marketplaces Plugins live in, newest first: the organization's own and its members' personal ones.
Get Plugin Marketplace
client.beta.organization.pluginMarketplaces.retrieve(marketplaceID, params?, options?): BetaPluginMarketplaceRetrieve a plugin marketplace by ID.
Update Plugin Marketplace
client.beta.organization.pluginMarketplaces.update(marketplaceID, params, options?): 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
client.beta.organization.pluginMarketplaces.validateRepository(params, options?): 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
client.beta.organization.pluginMarketplaces.validateArchive(params, options?): BetaPluginMarketplaceValidationReportCheck whether a plugin marketplace, uploaded as a .zip of the marketplace
directory, would synchronize into claude.ai, without connecting or storing it.