One change
Archive Federation Issuer
api/admin/federation_issuers/archive
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.
api/admin/federation_issuers/archive Changed · +38 / -29 lines
# Archive Federation Issuer ## Path parameters ## Headers ## Returns ## Example ### Response (200) ## Archive Federation Issuer ### Path Parameters ### Header Parameters ### Returns ### Example #### Response
from line 1
---- -title: Archive Federation Issuer -url: https://platform.claude.com/docs/en/api/admin/federation_issuers/archive ---- +# Archive Federation Issuer -## Archive Federation Issuer +**POST** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` -**post** `/v1/organizations/federation_issuers/{federation_issuer_id}/archive` - Archive a federation issuer. Idempotent; re-archiving returns the issuer with its original
from line 12
Requires an OAuth bearer or Console session; Admin API keys are not accepted. -### Path Parameters +## Path parameters - `federation_issuer_id: string` ID of the federation issuer to archive. -### Header Parameters +## Headers - `"anthropic-beta": optional array of string`
from line 26
To use multiple betas, use a comma separated list like `beta1,beta2` or specify the header multiple times for each beta. -### Returns +## Returns -- `FederationIssuer object { id, archived_at, archived_by_actor_id, 12 more }` +- `FederationIssuer object` Registered external OIDC identity provider.
from line 43
If set, all rules referencing this issuer reject token exchange. + format: date-time + - `archived_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that archived this issuer.
from line 57
When this issuer was created. + format: date-time + - `created_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that created this issuer.
from line 67
The `iss` claim value. Incoming JWTs must match exactly. - - `jwks: object { type, ca_cert_pem, discovery_base } or object { type, url, ca_cert_pem } or object { keys, type }` + - `jwks: object or object or object` How signing keys are obtained for signature verification. - - `Discovery object { type, ca_cert_pem, discovery_base }` + - `Discovery object` JWKS via the issuer's OIDC discovery document. - `type: "discovery"` - - `"discovery"` - - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. + maxLength: 8192 + - `discovery_base: optional string or null` Set when the discovery URL differs from `issuer_url`. - - `ExplicitURL object { type, url, ca_cert_pem }` + - `ExplicitURL object` JWKS fetched from a fixed endpoint. - `type: "explicit_url"` - - `"explicit_url"` - - `url: string` JWKS endpoint. + minLength: 1 + - `ca_cert_pem: optional string or null` Optional custom CA (PEM) for TLS verification of the JWKS fetch. - - `Inline object { keys, type }` + maxLength: 8192 + - `Inline object` + JWKS supplied directly; no network fetch. - `keys: array of map[unknown]`
from line 113
Inline JWK objects. + minItems: 1 + - `type: "inline"` - - `"inline"` - - `jwks_polling_disabled_at: string or null` If set, Anthropic's JWKS poller has paused polling for this issuer after repeated fetch failures. Re-enable by sending `jwks_polling_disabled: false` via the issuer update endpoint (POST) once the upstream JWKS endpoint is fixed. An OAuth caller cannot send this when the issuer backs a rule with any scope other than `workspace:developer` or `workspace:inference`; use a Console session. + format: date-time + - `max_jwt_lifetime_seconds: number` Maximum allowed iat→exp spread for assertions from this issuer (1-176400 seconds, i.e. up to 49h). Assertions must carry both `iat` and `exp`; a missing `iat` is rejected.
from line 131
Admin-chosen slug identifier. - - `poll_status: object { consecutive_failures, last_fetched_at, next_poll_at } or null` + - `poll_status: object or null` Status of automatic JWKS polling for a federation issuer.
from line 147
When the last successful fetch completed. + format: date-time + - `next_poll_at: string or null` When the next fetch is scheduled. Null if paused. + format: date-time + - `type: "federation_issuer"` - - `"federation_issuer"` + default: federation_issuer - `updated_at: string` When this issuer was last updated. + format: date-time + - `updated_by_actor_id: string or null` Tagged ID (`user_`/`svac_`) of the actor that last updated this issuer. -### Example +## Example -```http +```bash curl https://api.anthropic.com/v1/organizations/federation_issuers/$FEDERATION_ISSUER_ID/archive \ -X POST \ -H 'anthropic-version: 2023-06-01' \
from line 178
-H "Authorization: Bearer $ANTHROPIC_OAUTH_TOKEN" ``` -#### Response +### Response (200) ```json {