Management API

Every answer is checked against the model shown here before it is sent, and no answer carries a member its model does not list. A member shown as any JSON is one whose shape belongs to somebody else, and says whose. .{key} is a key that is data, and [] an element of a list.

A refusal

Unless an operation below says otherwise, any status it does not list answers this:

Member Type Required What it is
error string    
error_description string    
errors list    
errors[] string    
message string    
ok boolean    
status integer    
why string    

GET /admin-api/oidfed

getOidfed

This realm as an OpenID Federation entity: its role, Entity Configuration, keys, subordinates, Trust Anchors and Trust Marks

Everything /admin/oidfed draws, out of the same view function: the realm’s Entity Identifier and role (trust anchor, intermediate or leaf), its authority hints and federation endpoints, its Federation Entity Keys (public halves, states and history — never a private key), the subordinates it vouches for, the Trust Anchors it trusts, the Trust Mark types it issues, the marks it has issued and carries, the mark policies it publishes as a Trust Anchor, the resolutions it holds, and the claims of its current Entity Configuration — and, for each subordinate, whether it is suspended and its event history, the subordinates it has revoked with theirs (#137), and the Entity Collection crawl it keeps (#136). The keys, subordinates, revoked subordinates, Trust Anchors, issued and carried marks and mark policies are each one page, moved by a parameter of its own with per shared; counts holds each list’s whole length and paging where each page is. A subordinate’s events are its latest 25, with eventsTotal; the whole history is at /oidfed/subordinate-events. The oidfed.* settings are written through POST /admin-api/config/set-many.

Mirrors GET /admin/oidfed on the admin console.

The reply also carries protocolEndpoints: every endpoint of this family in the realm the call arrived in, as { name, methods, url } (plus route for an HTTP endpoint, transport for a socket, and registered: false for a route the router no longer has).

Scope: admin:read.

Parameters

Name In Type Required What it is
keysPage query integer   Which page of the Federation Entity Keys. Clamped, like every page parameter here.
subordinatesPage query integer   Which page of the subordinates. Clamped, like every page parameter here.
formerPage query integer   Which page of the revoked subordinates. Clamped, like every page parameter here.
anchorsPage query integer   Which page of the Trust Anchors. Clamped, like every page parameter here.
issuedPage query integer   Which page of the Trust Marks this realm issued. Clamped, like every page parameter here.
heldPage query integer   Which page of the Trust Marks this realm carries. Clamped, like every page parameter here.
policiesPage query integer   Which page of the Trust Mark policies. Clamped, like every page parameter here.
per query integer   Rows per page, shared by the seven lists.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The realm as a federation entity.

Member Type Required What it is
authorityHints list    
authorityHints[] string    
collection object    
collection.crawl object    
collection.crawl.crawledAt string    
collection.crawl.entities integer    
collection.crawl.entityId string    
collection.crawl.forThisIdentifier boolean    
collection.crawl.problems list    
collection.crawl.problems[] string    
collection.crawl.truncated boolean    
collection.crawlEveryS number    
collection.jobOff string    
configurationUrl string    
counts object    
counts.formerSubordinates integer    
counts.heldMarks integer    
counts.issuedMarks integer    
counts.keys integer    
counts.markPolicies integer    
counts.subordinates integer    
counts.trustAnchors integer    
endpoints object    
endpoints.collection string    
endpoints.configuration string    
endpoints.extendedList string    
endpoints.fetch string    
endpoints.historicalKeys string    
endpoints.list string    
endpoints.register string    
endpoints.resolve string    
endpoints.subordinateEvents string    
endpoints.trustMark string    
endpoints.trustMarkList string    
endpoints.trustMarkStatus string    
entityConfiguration any JSON   This realm’s Entity Configuration, the claims of a signed statement (OpenID Federation 1.1 section 3.1): its metadata is one document per entity type, and each is the document that protocol publishes. This realm’s Entity Configuration, the claims of a signed statement (OpenID Federation 1.1 section 3.1): its metadata is one document per entity type, and each is the document that protocol publishes.
entityConfigurationProblem string, or null    
entityId string    
formerSubordinates list    
formerSubordinates[].entityId string    
formerSubordinates[].events list    
formerSubordinates[].events[].event string    
formerSubordinates[].events[].event_description string    
formerSubordinates[].events[].iat number    
formerSubordinates[].events[].information_uri string    
formerSubordinates[].eventsTotal integer    
formerSubordinates[].localRealm string, or null    
heldMarks list    
heldMarks[].expiresAt string, or null    
heldMarks[].id string    
heldMarks[].iss string    
heldMarks[].type string    
issuedMarks list    
issuedMarks[].expiresAt string, or null    
issuedMarks[].id string    
issuedMarks[].issuedAt string, or null    
issuedMarks[].revokedReason string, or null    
issuedMarks[].status string    
issuedMarks[].sub string    
issuedMarks[].type string    
keys list    
keys[].activatedAt string, or null    
keys[].alg string    
keys[].createdAt string, or null    
keys[].kid string    
keys[].publicJwk object    
keys[].publicJwk.alg string    
keys[].publicJwk.crv string    
keys[].publicJwk.e string    
keys[].publicJwk.ek string    
keys[].publicJwk.ext boolean    
keys[].publicJwk.key_ops list    
keys[].publicJwk.key_ops[] string    
keys[].publicJwk.kid string    
keys[].publicJwk.kty string    
keys[].publicJwk.n string    
keys[].publicJwk.pub string    
keys[].publicJwk.use string    
keys[].publicJwk.x string    
keys[].publicJwk.x5c list    
keys[].publicJwk.x5c[] string    
keys[].publicJwk.x5t string    
keys[].publicJwk.x5t#S256 string    
keys[].publicJwk.x5u string    
keys[].publicJwk.y string    
keys[].publishedUntil string, or null    
keys[].retiredAt string, or null    
keys[].revokedAt string, or null    
keys[].revokedReason string, or null    
keys[].sealed boolean    
keys[].state string    
markPolicies list    
markPolicies[].issuers list    
markPolicies[].issuers[] string    
markPolicies[].owner string, or null    
markPolicies[].type string    
markTypes list    
markTypes[].delegation string    
markTypes[].lifetimeS number    
markTypes[].logoUri string    
markTypes[].ref string    
markTypes[].type string    
paging object    
paging.formerSubordinates object    
paging.formerSubordinates.firstRow integer    
paging.formerSubordinates.lastRow integer    
paging.formerSubordinates.noun string    
paging.formerSubordinates.page integer    
paging.formerSubordinates.pages integer    
paging.formerSubordinates.param string    
paging.formerSubordinates.perPage integer    
paging.formerSubordinates.total integer    
paging.heldMarks object    
paging.heldMarks.firstRow integer    
paging.heldMarks.lastRow integer    
paging.heldMarks.noun string    
paging.heldMarks.page integer    
paging.heldMarks.pages integer    
paging.heldMarks.param string    
paging.heldMarks.perPage integer    
paging.heldMarks.total integer    
paging.issuedMarks object    
paging.issuedMarks.firstRow integer    
paging.issuedMarks.lastRow integer    
paging.issuedMarks.noun string    
paging.issuedMarks.page integer    
paging.issuedMarks.pages integer    
paging.issuedMarks.param string    
paging.issuedMarks.perPage integer    
paging.issuedMarks.total integer    
paging.keys object    
paging.keys.firstRow integer    
paging.keys.lastRow integer    
paging.keys.noun string    
paging.keys.page integer    
paging.keys.pages integer    
paging.keys.param string    
paging.keys.perPage integer    
paging.keys.total integer    
paging.markPolicies object    
paging.markPolicies.firstRow integer    
paging.markPolicies.lastRow integer    
paging.markPolicies.noun string    
paging.markPolicies.page integer    
paging.markPolicies.pages integer    
paging.markPolicies.param string    
paging.markPolicies.perPage integer    
paging.markPolicies.total integer    
paging.subordinates object    
paging.subordinates.firstRow integer    
paging.subordinates.lastRow integer    
paging.subordinates.noun string    
paging.subordinates.page integer    
paging.subordinates.pages integer    
paging.subordinates.param string    
paging.subordinates.perPage integer    
paging.subordinates.total integer    
paging.trustAnchors object    
paging.trustAnchors.firstRow integer    
paging.trustAnchors.lastRow integer    
paging.trustAnchors.noun string    
paging.trustAnchors.page integer    
paging.trustAnchors.pages integer    
paging.trustAnchors.param string    
paging.trustAnchors.perPage integer    
paging.trustAnchors.total integer    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
realmsAreSubordinates boolean    
resolutions list    
resolutions[].anchor string    
resolutions[].chain list    
resolutions[].chain[].exp number    
resolutions[].chain[].iss string    
resolutions[].chain[].sub string    
resolutions[].expiresAt string    
resolutions[].metadata any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
resolutions[].subject string    
resolutions[].trustMarks list    
resolutions[].trustMarks[] string, or null    
role string    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map    
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string, or number, or boolean, or null    
settings.groups[].settings[].default list, or string, or number, or boolean, or null    
settings.groups[].settings[].default[] string, or number, or boolean, or null    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string, or number, or boolean, or null    
settings.groups[].settings[].env list, or string    
settings.groups[].settings[].env[] string    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv list, or string    
settings.groups[].settings[].legacyEnv[] string    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string    
settings.groups[].settings[].selectAll object    
settings.groups[].settings[].selectAll.aloneWhileOn list    
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn list    
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or string, or number, or boolean, or null    
settings.groups[].settings[].value[] string, or number, or boolean, or null    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map    
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
signingAlg string    
statementLifetimeS number    
subordinates list    
subordinates[].constraints any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinates[].createdAt string, or null    
subordinates[].entityId string    
subordinates[].entityTypes list    
subordinates[].entityTypes[] string    
subordinates[].events list    
subordinates[].events[].event string    
subordinates[].events[].event_description string    
subordinates[].events[].iat number    
subordinates[].events[].information_uri string    
subordinates[].eventsTotal integer    
subordinates[].implicit boolean    
subordinates[].intermediate boolean    
subordinates[].kids list    
subordinates[].kids[] string, or null    
subordinates[].localRealm string, or null    
subordinates[].metadataPolicy any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinates[].suspended object    
subordinates[].suspended.at string, or null    
subordinates[].suspended.informationUri string, or null    
subordinates[].suspended.reason string, or null    
subordinates[].updatedAt string, or null    
trustAnchors list    
trustAnchors[].entityId string    
trustAnchors[].kids list    
trustAnchors[].kids[] string, or null    
trustAnchors[].localRealm string, or null    

POST /admin-api/oidfed/add-held-mark

addOidfedHeldMark

Carry a Trust Mark issued to this realm

The Entity Configuration carries it in trust_marks (3.1.2).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
trustMark string yes A trust-mark+jwt whose sub is this realm.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/add-mark-type

addOidfedMarkType

Issue Trust Marks of a type

Registers a type this realm issues, with its lifetime and, where another entity owns the type, the delegation it issues under (7.2).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
delegation string   A trust-mark-delegation+jwt.
lifetimeS integer   Seconds each mark lives; oidfed.trustMarkLifetimeS when absent.
logoUri string    
ref string    
type string yes The Trust Mark type identifier, a URL.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
markType object    
markType.delegation string    
markType.lifetimeS number    
markType.logoUri string    
markType.ref string    
markType.type string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
markType object    
markType.delegation string    
markType.lifetimeS number    
markType.logoUri string    
markType.ref string    
markType.type string    
message string    
ok boolean yes  

POST /admin-api/oidfed/add-subordinate

addOidfedSubordinate

Register an entity this realm vouches for

The entity becomes a subordinate: the fetch endpoint issues a Subordinate Statement about it carrying its keys and whatever metadata, metadata policy and constraints are given here. Its keys are given (jwks) or read from its own Entity Configuration (fetchJwks, through the outbound policy).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
constraints any JSON   constraints (6.2), as a JSON object or its text.
entityId string yes An Entity Identifier: an https URL with no query or fragment.
entityTypes string   Its entity types, comma-separated, for the listing filter; read from its configuration when fetched.
eventDescription string   Recorded as the event_description of the event this act adds to the subordinate’s history.
fetchJwks boolean   Read its keys from its Entity Configuration.
informationUri string   An http or https URL of a page about the event, recorded as its information_uri.
intermediate boolean   Whether it is an Intermediate.
jwks any JSON   Its JWK Set, as a JSON object or its text.
metadata any JSON   Metadata overriding its own (3.1.1), as a JSON object or its text.
metadataPolicy any JSON   A metadata_policy (6.1), as a JSON object or its text.
metadataPolicyCrit string   Critical additional operators, comma-separated.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
subordinate object    
subordinate.constraints any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.createdAt string, or number, or null    
subordinate.entityId string    
subordinate.entityTypes list    
subordinate.entityTypes[] string    
subordinate.intermediate boolean    
subordinate.jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.localRealm string, or null    
subordinate.metadata any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.metadataPolicy any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.metadataPolicyCrit list    
subordinate.metadataPolicyCrit[] string    
subordinate.updatedAt string, or number, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
subordinate object    
subordinate.constraints any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.createdAt string, or number, or null    
subordinate.entityId string    
subordinate.entityTypes list    
subordinate.entityTypes[] string    
subordinate.intermediate boolean    
subordinate.jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.localRealm string, or null    
subordinate.metadata any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.metadataPolicy any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
subordinate.metadataPolicyCrit list    
subordinate.metadataPolicyCrit[] string    
subordinate.updatedAt string, or number, or null    

POST /admin-api/oidfed/add-trust-anchor

addOidfedTrustAnchor

Trust a Trust Anchor

A Trust Chain may end at it, verified by the keys configured here — given, or read from its Entity Configuration.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
entityId string yes An Entity Identifier: an https URL with no query or fragment.
fetchJwks boolean   Read its keys from its Entity Configuration.
jwks any JSON   Its JWK Set, as a JSON object or its text.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
message string    
ok boolean yes  

POST /admin-api/oidfed/crawl-collection

crawlOidfedCollection

Crawl the Entity Collection now

Walks every entity beneath the realm — each resolved to the realm before its own subordinates are listed, fetching from Intermediates outside this service through the outbound policy — and keeps what it finds for the collection endpoint (#136). The entity identifier is taken from this request.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body (optional)

An empty object.

200: What was done, with the record where there is one.

Member Type Required What it is
collection object    
collection.crawl object    
collection.crawl.crawledAt string    
collection.crawl.entities integer    
collection.crawl.entityId string    
collection.crawl.forThisIdentifier boolean    
collection.crawl.problems list    
collection.crawl.problems[] string    
collection.crawl.truncated boolean    
collection.crawlEveryS number    
collection.jobOff string    
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
collection object    
collection.crawl object    
collection.crawl.crawledAt string    
collection.crawl.entities integer    
collection.crawl.entityId string    
collection.crawl.forThisIdentifier boolean    
collection.crawl.problems list    
collection.crawl.problems[] string    
collection.crawl.truncated boolean    
collection.crawlEveryS number    
collection.jobOff string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/issue-trust-mark

issueOidfedTrustMark

Issue a Trust Mark to an entity

Signed with the realm’s Federation Entity Key; answered at the Trust Mark endpoint, and handed to the entity’s realm when it is one of this service’s.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
sub string yes An Entity Identifier: an https URL with no query or fragment.
type string yes  

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
id string    
message string    
ok boolean yes  
trustMark string    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
id string    
message string    
ok boolean yes  
trustMark string    

POST /admin-api/oidfed/reinstate-subordinate

reinstateOidfedSubordinate

Reinstate a suspended subordinate

Statements are issued about it again; its history records the reinstatement (#137).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
entityId string yes An Entity Identifier: an https URL with no query or fragment.
informationUri string   An http or https URL of a page about the event, recorded as its information_uri.
reason string   Recorded as the event_description of the event this act adds to the subordinate’s history.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/remove-held-mark

removeOidfedHeldMark

Stop carrying a Trust Mark

The Entity Configuration no longer carries it in trust_marks.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
id string yes  

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/remove-mark-policy

removeOidfedMarkPolicy

Remove a Trust Anchor’s policy for a type

trust_mark_issuers and trust_mark_owners no longer name it; a type the realm issues itself falls back to naming the realm.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
type string yes  

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/remove-mark-type

removeOidfedMarkType

Stop issuing a Trust Mark type

Marks already issued keep their status.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
type string yes  

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/remove-subordinate

removeOidfedSubordinate

Revoke a subordinate

The fetch endpoint no longer answers for it, and its history records the revocation — with the reason and the page given — and is kept (#137).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
entityId string yes An Entity Identifier: an https URL with no query or fragment.
informationUri string   An http or https URL of a page about the event, recorded as its information_uri.
reason string   Recorded as the event_description of the event this act adds to the subordinate’s history.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/remove-trust-anchor

removeOidfedTrustAnchor

Stop trusting a Trust Anchor

Chains ending at it are refused.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
entityId string yes An Entity Identifier: an https URL with no query or fragment.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/resolve

resolveOidfedEntity

Resolve an entity’s Trust Chain to one of this realm’s Trust Anchors

Walks its authority_hints, fetching what it must through the outbound policy and within oidfed.maxAuthorityHints, oidfed.maxChainDepth and oidfed.maxFetchesPerResolution, validates the chain, applies its metadata policy and verifies its Trust Marks. The result is what the resolve endpoint answers with afterwards.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
sub string yes An Entity Identifier: an https URL with no query or fragment.
trustAnchor string   The anchor to resolve to; any of the realm’s when absent.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
resolution object    
resolution.anchor string    
resolution.chain list    
resolution.chain[].exp number    
resolution.chain[].iss string    
resolution.chain[].sub string    
resolution.expiresAt string    
resolution.metadata any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
resolution.subject string    
resolution.trustMarks list    
resolution.trustMarks[] string, or null    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
resolution object    
resolution.anchor string    
resolution.chain list    
resolution.chain[].exp number    
resolution.chain[].iss string    
resolution.chain[].sub string    
resolution.expiresAt string    
resolution.metadata any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
resolution.subject string    
resolution.trustMarks list    
resolution.trustMarks[] string, or null    

POST /admin-api/oidfed/revoke-key

revokeOidfedKey

Revoke a retired Federation Entity Key

It leaves the published keys and is listed as revoked at the Historical Keys endpoint with the reason (8.7.3).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
kid string yes  
reason one of unspecified, compromised, superseded    

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/revoke-trust-mark

revokeOidfedTrustMark

Revoke a Trust Mark this realm issued

Its status becomes “revoked” (8.4).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
id string yes The mark’s id, from GET /admin-api/oidfed.
reason string    

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/oidfed/rotate-key

rotateOidfedKey

Rotate the realm’s Federation Entity Key

Queues a run of oidfed.key-rotate-now. An emergency rotation revokes the current and next keys as compromised; confirm it with confirm: “compromised”.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body (optional)

Member Type Required What it is
confirm one of compromised    
emergency boolean    

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
runId string, or number    

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  
runId string, or number    

POST /admin-api/oidfed/set-mark-policy

setOidfedMarkPolicy

As a Trust Anchor: who may issue a type, and who owns it

Published as trust_mark_issuers and trust_mark_owners (3.1.2).

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
issuers string   Entity Identifiers, comma-separated; none means anybody.
ownerJwks any JSON   The owner’s JWK Set, as a JSON object or its text.
ownerSub string   An Entity Identifier: an https URL with no query or fragment.
type string yes  

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
markPolicy object    
markPolicy.issuers list    
markPolicy.issuers[] string    
markPolicy.owner object    
markPolicy.owner.jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
markPolicy.owner.sub string    
markPolicy.type string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
markPolicy object    
markPolicy.issuers list    
markPolicy.issuers[] string    
markPolicy.owner object    
markPolicy.owner.jwks any JSON   A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further. A JWK Set, a metadata document, a metadata policy or a constraints object as an administrator gave it or a partner’s statement carried it (OpenID Federation 1.1 sections 3, 6): nothing here narrows it further.
markPolicy.owner.sub string    
markPolicy.type string    
message string    
ok boolean yes  

POST /admin-api/oidfed/suspend-subordinate

suspendOidfedSubordinate

Suspend a subordinate

The realm issues no Subordinate Statement about it and lists it nowhere until it is reinstated, so no Trust Chain passes through it; its history records the suspension (#137). A realm of this service beneath the default realm may be suspended too.

Mirrors POST /admin/oidfed on the admin console.

Scope: admin:write.

Parameters

Name In Type Required What it is
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

Request body

Member Type Required What it is
entityId string yes An Entity Identifier: an https URL with no query or fragment.
informationUri string   An http or https URL of a page about the event, recorded as its information_uri.
reason string   Recorded as the event_description of the event this act adds to the subordinate’s history.

200: What was done, with the record where there is one.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes  

400: The operation was refused; errors says why and nothing changed.

Member Type Required What it is
errors list    
errors[] string    
message string    
ok boolean yes