Claude Platform Docs

List Federation Rule Workspaces

$client->beta->organization->federation->rules->workspaces->list(string federationRuleID, ?int limit, ?string page, ?list<AnthropicBeta> betas): PageCursor<BetaFederationRuleWorkspace>
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.

List workspaces where this federation rule is enabled.

Returns all workspace enablements in a single response; the limit and page parameters are accepted but have no effect, and next_page is always null. Returns explicit per-workspace enablements only; for rules with applies_to_all_workspaces or a legacy single workspace_id, check those fields on the rule itself.

Parameters
federationRuleID: string

ID of the federation rule.

limit?:optional int

Number of results per page.

default20
page?:optional string

Opaque cursor from a previous response's next_page.

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.

List Federation Rule Workspaces
<?php

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

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

$page = $client->beta->organization->federation->rules->workspaces->list(
  'federation_rule_id',
  limit: 1,
  page: 'page',
  betas: [AnthropicBeta::MESSAGE_BATCHES_2024_09_24],
);

var_dump($page);
Returns Examples
Response 200
{
  "data": [
    {
      "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"
    }
  ],
  "next_page": "next_page"
}