List Federation Rule Workspaces

$ ant organization:federation:rules:workspaces list

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

--federation-rule-id: string⁠Path

ID of the federation rule.

--limit: optional number⁠Query

Number of results per page.

minimum1

maximum100

--page: optional string⁠Query

Opaque cursor from a previous response's next_page.

Returns

FederationRuleWorkspaceListResponse: object{ data, next_page }

data: array of FederationRuleWorkspace { type: "federation_rule_workspace", created_at, created_by_actor_id, 3 more }

type: "federation_rule_workspace"

created_at: string

When this workspace was enabled for the rule.

formatdate-time

created_by_actor_id: string

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

federation_rule_id: string

Tagged ID of the federation rule.

workspace_id: string

Tagged ID of the workspace this rule is enabled for.

workspace_name: string

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

next_page: string

Opaque cursor for the next page; null when there are no more results.

List Federation Rule Workspaces

ant organization:federation:rules:workspaces list \
  --api-key my-anthropic-api-key \
  --federation-rule-id federation_rule_id

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"
}

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"
}