Get Federation Rule changedapi/admin/federation_rules/retrieve
Nearest release: v2.1.245, published an hour after this site recorded the change. Shown because the two are within 24 hours of each other. Nothing here says the release caused the edit.
Recorded here
Lines+27added
Lines−22removed
From line
1
where the diff opens
First seen
14 Aug 2026
this site's first read of the page
Recorded edits4to this page, all time
# Get Federation Rule ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Get Federation Rule ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
The whole hunk
from line 1, old and new numbered
/
from line 1
1---
2title: Get Federation Rule
3url: https://platform.claude.com/docs/en/api/admin/federation_rules/retrieve
4---
1# Get Federation Rule
52
6## Get Federation Rule
3**GET** `/v1/organizations/federation_rules/{federation_rule_id}`
74
8**get** `/v1/organizations/federation_rules/{federation_rule_id}`
9
105Retrieve a federation rule by its ID (`fdrl_...`).
116
12### Path Parameters
7## Path parameters
138
149- `federation_rule_id: string`
1510
1611 ID of the federation rule.
1712
18### Header Parameters
13## Headers
1914
2015- `"anthropic-beta": optional array of string`
2116
from line 18
2318
2419 To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta.
2520
26### Returns
21## Returns
2722
28- `FederationRule object { id, applies_to_all_workspaces, archived_at, 17 more }`
23- `FederationRule object`
2924
3025 Authorization rule binding an external OIDC identity to Anthropic.
3126
from line 45
5045
5146 If set, this rule is archived and rejects token exchange.
5247
48 format: date-time
49
5350 - `archived_by_actor_id: string or null`
5451
5552 Tagged ID (`user_`/`svac_`) of the actor that archived this rule.
from line 59
6259
6360 When this rule was created.
6461
62 format: date-time
63
6564 - `created_by_actor_id: string or null`
6665
6766 Tagged ID (`user_`/`svac_`) of the actor that created this rule.
from line 77
7877
7978 Issuer's display name at read time.
8079
81 - `match: object { audience, claims, condition, subject_prefix }`
80 - `match: object`
8281
8382 Conditions the verified JWT must satisfy for this rule to apply. All populated matcher fields must pass.
8483
from line 85
8685
8786 Exact match against the `aud` claim (any element if array). When omitted, the JWT's `aud` must still equal Anthropic's expected audience for the issuer; setting this field overrides that default.
8887
88 maxLength: 1024
89
8990 - `claims: optional map[string] or null`
9091
9192 Exact-match `{claim: value}` pairs against top-level claims. Only string-valued claims can be matched; use `condition` for non-string claims.
from line 95
9495
9596 CEL expression over claims for logic the structural fields can't express. Must evaluate to a boolean and may reference only the `claims` variable; a constant-true expression (such as `true`) is rejected with 400.
9697
98 maxLength: 4096
99
97100 - `subject_prefix: optional string or null`
98101
99102 Match the verified JWT `sub` claim. Exact match unless the value ends with `*`, in which case it is a prefix match. Example: `repo:my-org/my-repo:ref:refs/heads/main`.
100103
104 maxLength: 1024
105
101106 - `name: string`
102107
103108 Admin-chosen slug identifier.
from line 111
106111
107112 Space-separated OAuth scopes granted on the minted token.
108113
109 - `target: object { service_account_id, type, service_account_name }`
114 - `target: object`
110115
111116 Identity that tokens minted via this rule act as. Currently always a `service_account` target.
112117
from line 121
116121
117122 - `type: "service_account"`
118123
119 - `"service_account"`
120
121124 - `service_account_name: optional string or null`
122125
123126 Service account's display name at read time. Ignored on writes.
from line 131
128131
129132 - `type: "federation_rule"`
130133
131 - `"federation_rule"`
134 default: federation_rule
132135
133136 - `updated_at: string`
134137
135138 When this rule was last updated.
136139
140 format: date-time
141
137142 - `updated_by_actor_id: string or null`
138143
139144 Tagged ID (`user_`/`svac_`) of the actor that last updated this rule.
from line 151
146151
147152 Tagged IDs of the workspaces this rule is enabled for. May be empty for older rules that only carry the legacy `workspace_id` binding. Ignored at exchange time when `applies_to_all_workspaces` is true (the list may still be non-empty).
148153
149### Example
154## Example
150155
151```http
156```bash
152157curl https://api.anthropic.com/v1/organizations/federation_rules/$FEDERATION_RULE_ID \
153158 -H 'anthropic-version: 2023-06-01' \
154159 -H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN"
155160```
156161
157#### Response
162### Response (200)
158163
159164```json
160165{
No line in this hunk matches that.