List Federation Rule Workspaces

organization.federation.rules.workspaces.list(federation_rule_id, **kwargs) -> PageCursor<FederationRuleWorkspace>

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: Integer⁠Query

Number of results per page.

minimum1

maximum100

page: String⁠Query

Opaque cursor from a previous response's next_page.

Returns

class FederationRuleWorkspace { type: :federation_rule_workspace, created_at, created_by_actor_id, 3 more }

type: :federation_rule_workspace

created_at: Time

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.

List Federation Rule Workspaces

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

page = anthropic.organization.federation.rules.workspaces.list("federation_rule_id")

puts(page)

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