API referenceObjectsfederation_issuer

The federation issuer object

⚠️
Preview — this feature is being built; the design below is the spec.

The federation_issuer object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "fiss_01JCJ8L0N2Q4S6U8W0Y2",
  "type": "federation_issuer",
  "issuer": "https://gitlab.internal.example.com",
  "display_name": "Self-managed GitLab",
  "jwks_uri": "https://gitlab.internal.example.com/oauth/discovery/keys",
  "discovery": "oidc",
  "allowed_algorithms": [
    "RS256",
    "ES256"
  ],
  "status": "verified",
  "keys_refreshed_at": "2026-11-05T10:00:01Z",
  "created_at": "2026-10-18T12:00:00Z"
}

Fields

FieldTypeDescription
idstringUnique id of this object.
typestringThe object type, always federation_issuer.
issuerstringMust match the iss claim exactly, including scheme and no trailing slash.
display_namestringSee the endpoint pages below.
jwks_uristringWhere signing keys are fetched. Found through OIDC discovery unless set by hand.
discoverystringoidc (keys located through /.well-known/openid-configuration) or static (jwks_uri given directly).
allowed_algorithmsarraySignature algorithms accepted. none and HMAC algorithms are never accepted.
statusstringverified once keys were fetched, unreachable if the last three refreshes failed.
keys_refreshed_atstringKeys are refreshed hourly and on an unknown kid.
created_atstringWhen it was created, RFC 3339 UTC (some older objects use Unix seconds).

Returned by

Was this page helpful?