Claude Platform Docs

フェデレーションルールのワークスペースを追加

$client->beta->organization->federation->rules->workspaces->add(string federationRuleID, string workspaceID, ?list<AnthropicBeta> betas): BetaFederationRuleWorkspace
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

org:admin スコープを持つ OAuth アクセストークンが必要です。これは ant auth login --scope org:admin またはワークロード ID フェデレーションルールから取得します。Admin APIキーは受け付けられません。Admin API で WIF を管理するを参照してください。

ワークスペースに対してフェデレーションルールを有効化します。

べき等です。再度有効化すると既存の有効化が返されます。ルールとワークスペースはどちらも組織に属している必要があります。ルールのターゲットサービスアカウントがこのワークスペースのメンバーであるかどうかは、有効化時にはチェックされません。ターゲットがメンバーでない限り、このワークスペースへのトークン交換は拒否されます(デフォルトワークスペースには暗黙的にメンバーとして所属します)。アーカイブ済みのルールは 400 で拒否されます。OAuth 呼び出し元が管理できるのは、oauth_scopeworkspace:developer または workspace:inference のルールのみです。その他のスコープには Console セッションが必要です。

Parameters
federationRuleID: string

ID of the federation rule.

workspaceID: string

Tagged ID of the workspace to enable this rule for.

betas?:optional list<AnthropicBeta>

Optional header to specify the beta version(s) you want to use.

Returns
class BetaFederationRuleWorkspace { $type = 'federation_rule_workspace'; $createdAt; $createdByActorID; /* 3 more */ }
"federation_rule_workspace" type
\Datetime createdAt

When this workspace was enabled for the rule.

?string createdByActorID

Tagged ID (user_... or svac_...) of the actor that enabled this workspace for the rule, if known.

string federationRuleID

Tagged ID of the federation rule.

string workspaceID

Tagged ID of the workspace this rule is enabled for.

?string workspaceName

Workspace display name. Populated when listing; null in the enable response.

フェデレーションルールのワークスペースを追加
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'my-anthropic-api-key');

$betaFederationRuleWorkspace = $client
  ->beta
  ->organization
  ->federation
  ->rules
  ->workspaces
  ->add(
  'federation_rule_id',
  workspaceID: 'workspace_id',
  betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24],
);

var_dump($betaFederationRuleWorkspace);
Returns Examples
Response 200
{
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by_actor_id": "created_by_actor_id",
  "federation_rule_id": "federation_rule_id",
  "type": "federation_rule_workspace",
  "workspace_id": "workspace_id",
  "workspace_name": "workspace_name"
}