Sign in

List Federation Rules

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 federation rules in your organization.

Optionally filter by issuer with issuer_id. Archived rules are excluded unless include_archived=true.

get/v1/organizations/federation_rules?beta=true

Query parameters

limitinteger

Number of results per page.

Number of results per page.

pagestring nullable

Opaque cursor from a previous response's next_page.

Opaque cursor from a previous response's next_page.

issuer_idstring nullable

Filter to rules referencing this federation issuer.

Filter to rules referencing this federation issuer.

include_archivedboolean

Include archived resources. Defaults to false.

Include archived resources. Defaults to false.

Headers

anthropic-betastring

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

Optional header to specify the beta version(s) you want to use.

To use multiple betas, use a comma separated list like beta1,beta2 or specify the header multiple times for each beta.

x-api-keystring

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

Your unique Admin API key for authentication.

This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.

anthropic-versionstring

The version of the Claude API you want to use.

Read more about versioning and our version history here.

The version of the Claude API you want to use.

Read more about versioning and our version history here.

Response

Successful Response

next_pagestring nullable required

Opaque cursor for the next page, or null if no more results.

Example response

{
  "data": [
    {
      "created_at": "2024-10-30T23:58:27.427722Z",
      "id": "fdrl_01SDCCSbTxrXDpWc1phhtcfK",
      "name": "prod-deploy-pipeline",
      "target": {
        "service_account_id": "svac_01SDCCSbTxrXDpWc1phhtcfK"
      },
      "updated_at": "2024-10-30T23:58:27.427722Z"
    }
  ]
}

Changes

Changed in 1 of the 68 revisions of this API.1