組織
取得目前組織
$client->organization->retrieve(): OrganizationInfo擷取與已驗證 API 金鑰相關聯之組織的資訊。
Models
組織API 金鑰
擷取 API 金鑰(Admin API)
$client->organization->apiKeys->retrieve(string apiKeyID): APIKey依 ID 查詢並擷取您組織中單一 API 金鑰的資訊。此 Admin API 端點需要 Admin API 金鑰,適用於以程式方式管理金鑰,且絕不會傳回金鑰的秘密值。若要檢視或建立您自己的 API 金鑰,請前往 Claude Console 中的 API 金鑰。
組織外部金鑰
建立外部金鑰
$client->organization->externalKeys->create(ProviderConfig providerConfig, ?string displayName, ?Geo geo, ?string userProfileID): ExternalKey建立由呼叫者組織擁有的外部金鑰設定。
列出外部金鑰
$client->organization->externalKeys->list(?int limit, ?string page): PageCursor<ExternalKey>列出呼叫者組織中的外部金鑰設定。
取得外部金鑰
$client->organization->externalKeys->retrieve(string externalKeyID): ExternalKey依 ID 擷取呼叫者組織中的單一外部金鑰設定。
更新外部金鑰
$client->organization->externalKeys->update(string externalKeyID, ?string displayName, ?Geo geo, ?ProviderConfig providerConfig): ExternalKey部分更新外部金鑰設定。省略的欄位將保持不變。
刪除外部金鑰
$client->organization->externalKeys->delete(string externalKeyID): ExternalKeyDeleteResponse刪除外部金鑰設定。
驗證外部金鑰
$client->organization->externalKeys->validate(string externalKeyID): ExternalKeyValidateResponse針對客戶的 KMS 驗證外部金鑰設定。
組織聯合簽發者
建立聯合簽發者
$client->organization->federation->issuers->create(string issuerURL, string name, ?bool checkJTI, ?JWKS jwks, ?int maxJWTLifetimeSeconds): FederationIssuer需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
列出聯合簽發者
$client->organization->federation->issuers->list(?bool includeArchived, ?int limit, ?string page): PageCursor<FederationIssuer>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
取得聯合簽發者
$client->organization->federation->issuers->retrieve(string federationIssuerID): FederationIssuer需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
更新聯合簽發者
$client->organization->federation->issuers->update(string federationIssuerID, ?bool checkJTI, ?string issuerURL, ?JWKS jwks, ?bool jwksPollingDisabled, ?int maxJWTLifetimeSeconds, ?string name): FederationIssuer需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
封存聯合簽發者
$client->organization->federation->issuers->archive(string federationIssuerID): FederationIssuer需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織聯合規則
建立聯合規則
$client->organization->federation->rules->create(string issuerID, FederationRuleMatch match, string name, string oauthScope, ServiceAccountTarget target, ?bool appliesToAllWorkspaces, ?string description, ?int tokenLifetimeSeconds, ?string workspaceID): FederationRule需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
列出聯合規則
$client->organization->federation->rules->list(?bool includeArchived, ?string issuerID, ?int limit, ?string page): PageCursor<FederationRule>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
取得聯合規則
$client->organization->federation->rules->retrieve(string federationRuleID): FederationRule需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
更新聯合規則
$client->organization->federation->rules->update(string federationRuleID, ?bool appliesToAllWorkspaces, ?string description, ?FederationRuleMatch match, ?string name, ?string oauthScope, ?ServiceAccountTarget target, ?int tokenLifetimeSeconds, ?string workspaceID): FederationRule需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
封存聯合規則
$client->organization->federation->rules->archive(string federationRuleID): FederationRule需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織聯合規則工作區
新增聯合規則工作區
$client->organization->federation->rules->workspaces->add(string federationRuleID, string workspaceID): FederationRuleWorkspace需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
列出聯合規則工作區
$client->organization->federation->rules->workspaces->list(string federationRuleID, ?int limit, ?string page): PageCursor<FederationRuleWorkspace>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
移除聯合規則工作區
$client->organization->federation->rules->workspaces->remove(string workspaceID, string federationRuleID): WorkspaceRemoveResponse需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織邀請
建立邀請
$client->organization->invites->create(string email, Role role, ?list<string> rbacGroupIDs): OrganizationInvite透過電子郵件邀請使用者加入組織。
列出邀請
$client->organization->invites->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles, ?list<Status> statuses): Page<OrganizationInvite>列出組織的邀請。
取得邀請
$client->organization->invites->retrieve(string inviteID): OrganizationInvite依 ID 擷取邀請。
刪除邀請
$client->organization->invites->delete(string inviteID): InviteDeleteResponse刪除待處理的邀請。
組織服務帳戶
建立服務帳戶
$client->organization->serviceAccounts->create(string name, ?string description, ?OrganizationRole organizationRole): ServiceAccount需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
列出服務帳戶
$client->organization->serviceAccounts->list(?bool includeArchived, ?int limit, ?string page): PageCursor<ServiceAccount>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
取得服務帳戶
$client->organization->serviceAccounts->retrieve(string serviceAccountID): ServiceAccount需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
更新服務帳戶
$client->organization->serviceAccounts->update(string serviceAccountID, ?string description, ?OrganizationRole organizationRole): ServiceAccount需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
封存服務帳戶
$client->organization->serviceAccounts->archive(string serviceAccountID): ServiceAccount需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織服務帳戶工作區
將工作區新增至服務帳戶
$client->organization->serviceAccounts->workspaces->add(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
列出服務帳戶的工作區
$client->organization->serviceAccounts->workspaces->list(string serviceAccountID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
從服務帳戶移除工作區
$client->organization->serviceAccounts->workspaces->remove(string workspaceID, string serviceAccountID): WorkspaceRemoveResponse需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織使用者
列出使用者
$client->organization->users->list(?string afterID, ?string beforeID, ?string email, ?int limit, ?list<string> roles): Page<OrganizationUser>列出組織的成員。
取得使用者
$client->organization->users->retrieve(string userID): OrganizationUser依使用者 ID 擷取組織成員。
更新使用者
$client->organization->users->update(string userID, Role role): OrganizationUser更新成員的組織角色。
移除使用者
$client->organization->users->remove(string userID): UserRemoveResponse從組織中移除成員。
組織工作區
建立工作區
$client->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array<string,string> tags, ?string userProfileID): Workspace更新工作區
$client->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array<string,string> tags, ?string userProfileID): Workspace組織工作區速率限制
列出工作區速率限制
$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>列出工作區的速率限制。
設定工作區速率限制
$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimit為工作區中的單一速率限制群組設定或清除速率限制覆寫。
組織工作區成員
列出工作區成員
$client->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page<WorkspaceMember>建立工作區成員
$client->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMember取得工作區成員
$client->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMember更新工作區成員
$client->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMember刪除工作區成員
$client->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponse組織工作區服務帳戶
列出服務帳戶工作區成員
$client->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
建立服務帳戶工作區成員
$client->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
取得服務帳戶工作區成員
$client->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID): ServiceAccountWorkspaceMember需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
更新服務帳戶工作區成員
$client->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合(workload identity federation)規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
刪除服務帳戶工作區成員
$client->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID): ServiceAccountRemoveResponse需要具有 org:admin 範圍的 OAuth 存取權杖,可透過 ant auth login --scope org:admin 或工作負載身分聯合規則取得;不接受 Admin API 金鑰。請參閱使用 Admin API 管理 WIF。
組織速率限制
列出組織速率限制
$client->organization->rateLimits->list(?GroupType groupType, ?int limit, ?string model, ?string page): PageCursor<OrganizationRateLimit>列出您組織的 Messages API 速率限制。
組織合規設定
取得合規設定
$client->organization->complianceSettings->retrieve(): OrganizationComplianceSettings擷取您組織的合規設定。
更新合規設定
$client->organization->complianceSettings->update(ComplianceSettingsStateParam state): OrganizationComplianceSettings更新您組織的合規設定。
組織分析摘要
取得活動摘要
$client->organization->analytics->summaries->list(\Datetime startingDate, ?\Datetime endingDate, ?list<string> filter, ?int limit, ?string page): PageCursor<AnalyticsSingleDayActivitySummary>取得指定日期範圍內的全組織活動摘要。
組織分析使用者
列出使用者活動
$client->organization->analytics->users->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsUserGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsUserActivity>取得指定日期的每位使用者活動,採用游標式分頁。
組織分析應用程式聊天專案
取得聊天專案用量
$client->organization->analytics->apps->chat->projects->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsProjectGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsProjectActivity>取得指定日期的每個專案活動,並支援以游標為基礎的分頁。
組織分析連接器
取得連接器使用量
$client->organization->analytics->connectors->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsConnectorGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsConnectorActivity>取得指定日期的每個連接器用量,採用游標式分頁。
組織分析外掛程式
取得外掛程式使用量
$client->organization->analytics->plugins->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsPluginGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsPluginActivity>取得指定日期的每個外掛程式安裝與呼叫用量,採用分頁。
組織分析技能
取得技能使用量
$client->organization->analytics->skills->list(?\Datetime date, ?\Datetime endingDate, ?list<string> filter, ?list<AnalyticsSkillGroupBy> groupBy, ?int limit, ?AnalyticsOrder order, ?string orderBy, ?string page, ?\Datetime startingDate): PageCursor<AnalyticsSkillActivity>取得指定日期的每項技能用量,採用游標式分頁。
組織分析Artifacts
取得 Artifact 活動
$client->organization->analytics->artifacts->list(\Datetime date, ?list<string> filter, ?list<AnalyticsArtifactGroupBy> groupBy, ?int limit, ?string page): PageCursor<AnalyticsArtifactActivity>取得指定日期的 artifact 建立活動,依 MIME 類型細分。
組織支出限制有效
列出有效支出限制
$client->organization->spendLimits->effective->list(?int limit, ?string page, ?list<SpendLimitPeriod> period, ?list<string> userIDs): PageCursor<SpendSummary>列出每位成員的有效支出限制及本期至今的支出。
組織支出限制提高請求
列出支出限制提高請求
$client->organization->spendLimits->increaseRequests->list(?list<string> actorIDs, ?int limit, ?string page, ?list<SpendLimitIncreaseRequestStatus> status): PageCursor<SpendLimitIncreaseRequest>列出支出限制提高請求,最新的在前。
取得支出限制提高請求
$client->organization->spendLimits->increaseRequests->retrieve(string spendLimitIncreaseRequestID): SpendLimitIncreaseRequest擷取支出限制提高請求。
核准支出限制提高請求
$client->organization->spendLimits->increaseRequests->approve(string spendLimitIncreaseRequestID, string amount, ?SpendLimitPeriod period, ?bool suppressNotification): IncreaseRequestApproveResponse核准待處理的支出限制提高請求。
拒絕支出限制提高請求
$client->organization->spendLimits->increaseRequests->deny(string spendLimitIncreaseRequestID, ?bool suppressNotification): SpendLimitIncreaseRequest拒絕待處理的支出限制提高請求。
組織RBAC 群組
建立 RBAC 群組
$client->organization->rbacGroups->create(string name): RBACGroup在 Claude Enterprise 租戶中建立 RBAC 群組。透過 API 建立的群組其來源類型為 "direct"。
列出 RBAC 群組
$client->organization->rbacGroups->list(?int limit, ?string page): PageCursor<RBACGroup>列出 Claude Enterprise 租戶中的 RBAC 群組。
取得 RBAC 群組
$client->organization->rbacGroups->retrieve(string rbacGroupID): RBACGroup依 ID 擷取 RBAC 群組。
更新 RBAC 群組
$client->organization->rbacGroups->update(string rbacGroupID, ?string name): RBACGroup更新 RBAC 群組的名稱。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")無法透過 API 修改。
刪除 RBAC 群組
$client->organization->rbacGroups->delete(string rbacGroupID): DeletedRBACGroup刪除 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")無法透過 API 刪除。
組織RBAC 群組成員
列出 RBAC 群組成員
$client->organization->rbacGroups->members->list(string rbacGroupID, ?int limit, ?string page): PageCursor<RBACGroupMember>列出 RBAC 群組的成員。
新增 RBAC 群組成員
$client->organization->rbacGroups->members->add(string rbacGroupID, string userID): RBACGroupMember將使用者新增至 RBAC 群組。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")其成員資格無法透過 API 修改。
移除 RBAC 群組成員
$client->organization->rbacGroups->members->remove(string userID, string rbacGroupID): DeletedRBACGroupMember從 RBAC 群組中移除使用者。當租用戶中的組織使用 SCIM 佈建時,由身分識別提供者佈建的群組(來源類型為 "scim")其成員資格無法透過 API 修改。
組織RBAC 角色
列出 RBAC 角色
$client->organization->rbacRoles->list(?int limit, ?string page): PageCursor<RBACRole>列出組織中的 RBAC 角色。
取得 RBAC 角色
$client->organization->rbacRoles->retrieve(string rbacRoleID): RBACRole依 ID 擷取 RBAC 角色。
組織RBAC 角色權限
列出 RBAC 角色權限
$client->organization->rbacRoles->permissions->list(string rbacRoleID, ?int limit, ?string page): PageCursor<RBACRolePermission>列出 RBAC 角色所授予的權限。