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/saml11

getSaml11RelyingParties

Every SAML 1.1 relying party, and the endpoints each is configured from

A full SAML 1.1 identity provider: both browser profiles — Browser/POST and Browser/Artifact — and the SAML responder behind the second, which also answers AttributeQuery and AuthenticationQuery and is therefore this service’s attribute authority.

IT IS NOT AN OLDER SPELLING OF GET /admin-api/saml2. SAML 1.1 has no request message, so a relying party cannot identify itself in the protocol: identifier comes from Shibboleth’s providerId parameter, from a scoped endpoint’s path segment, or it is GUESSED from the origin of the TARGET. It has no Single Logout, so there is no logout service to declare, and no request signature to record. It has an attribute authority, which the 2.0 profile does not.

Every relying party gets its own metadata document and one is minted for any identifier asked for, so nothing has to be provisioned before a relying party can be pointed at this service.

This resource holds nothing: every row is an entry in ou=applications, the same one GET /admin-api/applications reports — and the KIND is shared with WS-Federation, because a relying party handed the same assertion through the passive requestor profile is the same application. profiles says which of the two browser profiles it has actually used, and an empty list means it has only ever been handed a 1.1 assertion through another door.

?rp=<identifier> returns one of them, with what has been recorded about it — and answers 200 with found: false for an identifier that is not registered, whose metadata is still served and whose flow would still be answered.

Mirrors GET /admin/saml2 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
q query string   Part of a relying party’s identifier, case-insensitive, narrowing the list.
rp query string   One relying party, by its identifier.
page query integer   Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is.
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
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 relying parties with the paging that found them, or one of them with its endpoints and its record.

Member Type Required What it is
artifactsAwaitingResolution number    
assertionConsumerServices list    
assertionConsumerServices[] string    
assertionsHeldByReference number    
authentications number    
flowsHeldForSignIn number    
identifier string    
identifierLooksGuessed boolean    
idpProviderId string, or null    
kind string    
metadataUrl string    
name string    
nameIdFormats list    
nameIdFormats[] string    
paging object    
paging.firstRow integer    
paging.lastRow integer    
paging.noun string, or null    
paging.offset integer    
paging.page integer    
paging.pages integer    
paging.param string, or null    
paging.perPage integer    
paging.total integer    
profiles list    
profiles[] string    
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    
registered boolean    
relyingParties list    
relyingParties[].assertionConsumerServices list    
relyingParties[].assertionConsumerServices[] string    
relyingParties[].authentications number    
relyingParties[].firstSeen string    
relyingParties[].identifier string    
relyingParties[].idpProviderId string, or null    
relyingParties[].lastSeen string    
relyingParties[].metadataUrl string    
relyingParties[].name string, or null    
relyingParties[].nameIdFormats list    
relyingParties[].nameIdFormats[] string    
relyingParties[].profiles list    
relyingParties[].profiles[] string    
relyingParties[].responderUrl string    
relyingParties[].sessions number    
relyingParties[].slug string, or null    
relyingParties[].ssoUrl string    
relyingParties[].users number    
responderUrl 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, or null    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map   The sentence beside each value.
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string    
settings.groups[].settings[].default list, or boolean, or number, or string, or null    
settings.groups[].settings[].default[] string    
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    
settings.groups[].settings[].env string, or null    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv string, or null    
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 map   The rules by kind: onlyWhileOn and aloneWhileOn.
settings.groups[].settings[].selectAll.{key} list    
settings.groups[].settings[].selectAll.{key}[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.{key}[].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 boolean, or number, or string, or null    
settings.groups[].settings[].value[] string    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map   The other pages, by settings group.
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
slug string, or null    
ssoUrl string    
unscopedMetadata string    

POST /admin-api/saml11/register

registerSaml11RelyingParty

Register a relying party and its assertion consumer

OPTIONAL, and it changes nothing about whether a flow is accepted: this identity provider accepts any identifier, and the first flow or metadata fetch creates the entry anyway.

It buys two things here rather than the one it buys on the SAML 2.0 side. A metadata document to hand somebody before they have sent anything — and a NAME to put in providerId, which matters more in this protocol than in any other here: with no name sent, the audience of the assertion is guessed from the origin of the TARGET, and a relying party expecting a different audience refuses the assertion inside a signature check with nothing saying why.

It is refused for an identifier already in the registry — an identifier names ONE application here whatever protocol brought it, and a WS-Federation relying party taking 1.1 assertions is already one of these. shire is required and is recorded as the assertion consumer service. In product mode, the identity provider returns assertions only to an exactly registered address.

Mirrors POST /admin/saml2#saml-tab-saml11 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
rp string yes The relying party’s identifier.
shire string, uri yes The assertion consumer service URL registered on the relying party.

200: The application entry, and where its metadata is served.

Member Type Required What it is
application object    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   Attribute names, which are data in a schemaless directory, and values.
application.attributes.{key} list, or string, or null    
application.attributes.{key}[] string    
application.authentications number    
application.createdAt string, or null    
application.declaredKinds list    
application.declaredKinds[] string    
application.description string, or null    
application.dn string, or null    
application.dnLabel string, or null    
application.fields map   Attribute names, which are data in a schemaless directory, and values.
application.fields.{key} list, or string, or null    
application.fields.{key}[] string    
application.firstSeen string    
application.identifier string    
application.kinds list    
application.kinds[] string    
application.lastSeen string    
application.modifiedAt string, or null    
application.name string, or null    
application.operational list    
application.operational[] string    
application.origin string, or null    
application.protocols list    
application.protocols[] string    
application.recordedProtocols list    
application.recordedProtocols[] string    
application.registered boolean    
application.registeredBy string    
application.returnAddressesObserved list    
application.returnAddressesObserved[].attribute string    
application.returnAddressesObserved[].held boolean    
application.returnAddressesObserved[].trusted boolean    
application.returnAddressesObserved[].value string    
application.sessions number    
application.users number    
changed boolean    
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
application object    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   Attribute names, which are data in a schemaless directory, and values.
application.attributes.{key} list, or string, or null    
application.attributes.{key}[] string    
application.authentications number    
application.createdAt string, or null    
application.declaredKinds list    
application.declaredKinds[] string    
application.description string, or null    
application.dn string, or null    
application.dnLabel string, or null    
application.fields map   Attribute names, which are data in a schemaless directory, and values.
application.fields.{key} list, or string, or null    
application.fields.{key}[] string    
application.firstSeen string    
application.identifier string    
application.kinds list    
application.kinds[] string    
application.lastSeen string    
application.modifiedAt string, or null    
application.name string, or null    
application.operational list    
application.operational[] string    
application.origin string, or null    
application.protocols list    
application.protocols[] string    
application.recordedProtocols list    
application.recordedProtocols[] string    
application.registered boolean    
application.registeredBy string    
application.returnAddressesObserved list    
application.returnAddressesObserved[].attribute string    
application.returnAddressesObserved[].held boolean    
application.returnAddressesObserved[].trusted boolean    
application.returnAddressesObserved[].value string    
application.sessions number    
application.users number    
changed boolean    
errors list    
errors[] string    
message string    
ok boolean yes