This is the documentation of iya-sts 1.0.0. The latest is 1.1.0.

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

getApplications

Every application this service has been asked about, filtered and paged

The other side of /admin-api/users. That resource lists every identity that has authenticated here; this lists what they authenticated TO — every OAuth client, OpenID Connect relying party, SAML 2.0 or 1.1 service provider, WS-Federation application, WS-Trust relying party, OpenID4VP verifier and Kerberos service.

The entries ARE the registry. They live under ou=applications in the embedded LDAP directory and nothing caches them, so an ldapmodify is visible here on the next call — and changes what RFC 9700 mode enforces at the same moment. The RFC 7591 client registrations are those entries too.

One entry per identifier, whatever protocol brought it. The key is the identifier exactly as it arrived, so an application appearing under one name in two protocols is one row with two kinds rather than two rows.

?application=<id> returns ONE of them with every attribute of its directory entry and what the published schema says each attribute is; that reply pages its attribute list under attributesPage rather than page, which is the convention for a reply holding a list that is not the top-level one.

The ?application= reply’s authenticationEvents (#954) are the audit log’s authentication attempts that name this application, newest first: authentication, authentication.refused, session.refuse and session.refused, where detail.client_id or detail.application is the identifier or one of the entry’s protocol names, exactly as spelled. Each row is an audit event. authenticationEventsMatched is how many, authenticationEventsPaging pages them under authenticationsPage, authenticationEventsKnownActors says which actors have a user page, and authenticationEventsLog says how full the audit log is. The member is not authentications: that one is the count. The list holds no more history than the audit log does, and nothing in it is a credential. Another process’s rows are read before this reply is built, the same wait GET /admin-api/audit makes, so an attempt recorded on a different worker is on the list.

The ?application= reply’s page.passkeyPolicies (#609, #1235) is what the console draws as the read-only Passkey policy card of the Every protocol sub-tab: the passkey policy the application names in appPasskeyPolicy (named; default for none), missing (true where the realm holds no policy of that name, so the default applies), applies and its precedence (what a sign-in for the application gets before any person is known), groupPolicies (how many named policies a group names, which could still win for a member on a lower precedence) and link.

The ?application= reply’s credentials.stored (#1227) is what the entry stores in userCertificate, each certificate’s SHA-256, subject, issuer, serial and validity, in the shape GET /admin-api/users/certificates lists a person’s: an outside certificate authority’s certificate authenticates the application only while it is stored there and on no other entry. POST /admin-api/applications/add-certificate and remove-certificate change it.

This reply carries credentials — oauthClientSecret and appRegistrationAccessToken, opened. They are sealed at rest wherever the process holds a durable key-encryption key, but anyone who can read this reply can authenticate as that client.

Mirrors GET /admin/applications on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
claimsUser query string   On one application, the person the claims preview is drawn for. Defaults to the signed-in person.
application query string   One application, by its identifier exactly — the client_id, wtrealm, AppliesTo, entityID or service principal name. Answers 200 with found: false for one this service has never accepted, which is a different fact from one it has refused: an entry appears when an identifier is ACCEPTED, so a client whose every request was turned away has none.
q query string   Substring of the identifier or the name, case-insensitive. Ignored when application is given.
kind query one of oauth2-client, oauth2-resource-server, oidc-relying-party, saml2-service-provider, saml11-relying-party, wsfed-relying-party, wstrust-relying-party, oid4vp-verifier, federation-identity-provider, kerberos-service, gnap-client, gnap-resource-server   One kind. A record carrying SEVERAL matches on any of them — an OAuth client that asked for the openid scope is also a relying party — so these are not disjoint sets and the counts in the reply’s kinds member do not sum to the total.
exclude query array   An identifier to leave out of the match, exactly as spelled; repeat it for several (exclude=a&exclude=b). Applied before the paging, so a page still holds per rows. The console’s application search for appAllowedToDelegateTo and appAllowedToActOnBehalfOf sends the application itself and the values its list already holds. Ignored when application is given.
attributesPage query integer   Which page of the attribute list, on the ?application= reply only. Named rather than the bare page because it moves a list inside the reply rather than the reply itself.
authenticationsPage query integer   Which page of authenticationEvents, on the ?application= reply only. Named rather than the bare page so it does not move the attribute list.
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.
observedPage query integer   Which page of observed to return, answered by observedPaging. On the ?application= reply only: the claims observed on its tokens.
heldPage query integer   Which page of held to return, answered by heldPaging. On the ?application= reply only: the delegated permissions it holds.
exposedPage query integer   Which page of exposed to return, answered by exposedPaging. On the ?application= reply only: the permissions it exposes.
grantedOutPage query integer   Which page of grantedOut to return, answered by grantedOutPaging. On the ?application= reply only: the permissions it has granted out.
enrolledPage query integer   Which page of enrolled to return, answered by enrolledPaging. On the ?application= reply only: the certificates on its entry.
enrolledConfigPage query integer   Which page of enrolledConfig to return, answered by enrolledConfigPaging. On the ?application= reply only: those certificates on its configuration tab.
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 matching applications with the paging that found them, or one application with its directory entry when application was given.

Member Type Required What it is
allowedProtocols list    
allowedProtocols[] string    
applicationCount integer    
applicationRoles object    
applicationRoles.held list    
applicationRoles.held[].application string    
applicationRoles.held[].carriedAs string    
applicationRoles.held[].displayName string    
applicationRoles.held[].id string    
applicationRoles.held[].name string    
applicationRoles.held[].permissions list    
applicationRoles.held[].permissions[] string    
applicationRoles.offerable list    
applicationRoles.offerable[] string    
applicationRoles.requirable list    
applicationRoles.requirable[] string    
applicationRoles.required list    
applicationRoles.required[].displayName string    
applicationRoles.required[].name string    
applicationRoles.required[].resolves string    
applicationRoles.required[].role string    
applications list    
applications[].allowedProtocols list    
applications[].allowedProtocols[] string    
applications[].attributes map   By attribute name.
applications[].attributes.{key} list, or string, or number, or boolean, or null    
applications[].attributes.{key}[] string, or number, or boolean    
applications[].authentications number    
applications[].createdAt string, or null    
applications[].declaredKinds list    
applications[].declaredKinds[] string    
applications[].description string, or null    
applications[].dn string, or null    
applications[].dnLabel string, or null    
applications[].fields map   By attribute name.
applications[].fields.{key} list, or string, or number, or boolean, or null    
applications[].fields.{key}[] string, or number, or boolean    
applications[].firstSeen string    
applications[].identifier string    
applications[].kinds list    
applications[].kinds[] string    
applications[].lastSeen string    
applications[].modifiedAt string, or null    
applications[].name string, or null    
applications[].operational list    
applications[].operational[] string    
applications[].origin string, or null    
applications[].protocols list    
applications[].protocols[] string    
applications[].recordedProtocols list    
applications[].recordedProtocols[] string    
applications[].registered boolean    
applications[].registeredBy string    
applications[].returnAddressesObserved list    
applications[].returnAddressesObserved[].attribute string    
applications[].returnAddressesObserved[].held boolean    
applications[].returnAddressesObserved[].trusted boolean    
applications[].returnAddressesObserved[].value string    
applications[].secretExpiry object    
applications[].secretExpiry.at string    
applications[].secretExpiry.state string    
applications[].sessions number    
applications[].users number    
attributes map   By attribute name.
attributes.{key} list, or string, or number, or boolean, or null    
attributes.{key}[] string, or number, or boolean    
attributesPaging object    
attributesPaging.firstRow integer    
attributesPaging.lastRow integer    
attributesPaging.noun string    
attributesPaging.page integer    
attributesPaging.pages integer    
attributesPaging.param string    
attributesPaging.perPage integer    
attributesPaging.total integer    
attributesShown list    
attributesShown[].name string    
attributesShown[].operational boolean    
attributesShown[].sealedAtRest boolean    
attributesShown[].values list    
attributesShown[].values[] list, or string, or number, or boolean, or null    
attributesShown[].values[][] string, or number, or boolean    
authenticationEvents list    
authenticationEvents[].action string    
authenticationEvents[].actor string    
authenticationEvents[].actorForm string    
authenticationEvents[].address string    
authenticationEvents[].at number    
authenticationEvents[].category string    
authenticationEvents[].channel string    
authenticationEvents[].detail map   What the event recorded.
authenticationEvents[].detail.{key} string, or number, or boolean    
authenticationEvents[].errorCode string    
authenticationEvents[].mac string    
authenticationEvents[].origin string, or number, or null    
authenticationEvents[].outcome string    
authenticationEvents[].prev string    
authenticationEvents[].protocol string    
authenticationEvents[].seq number    
authenticationEvents[].summary string    
authenticationEvents[].target string    
authenticationEventsKnownActors map   Which actors have a user page.
authenticationEventsKnownActors.{key} boolean    
authenticationEventsLog object    
authenticationEventsLog.dropped number    
authenticationEventsLog.held number    
authenticationEventsLog.maxEvents number    
authenticationEventsLog.recorded number    
authenticationEventsMatched integer    
authenticationEventsPaging object    
authenticationEventsPaging.firstRow integer    
authenticationEventsPaging.lastRow integer    
authenticationEventsPaging.noun string    
authenticationEventsPaging.page integer    
authenticationEventsPaging.pages integer    
authenticationEventsPaging.param string    
authenticationEventsPaging.perPage integer    
authenticationEventsPaging.total integer    
authentications number    
certificateEnrollment object    
certificateEnrollment.certificateCap object    
certificateEnrollment.certificateCap.source string    
certificateEnrollment.certificateCap.value number    
certificateEnrollment.certificates list    
certificateEnrollment.certificates[].attestation list, or string, or number, or boolean, or null    
certificateEnrollment.certificates[].attestation[] string, or number, or boolean    
certificateEnrollment.certificates[].certificatePem string    
certificateEnrollment.certificates[].chainPem list    
certificateEnrollment.certificates[].chainPem[] string    
certificateEnrollment.certificates[].device string    
certificateEnrollment.certificates[].expired boolean    
certificateEnrollment.certificates[].family string    
certificateEnrollment.certificates[].issuedAt string    
certificateEnrollment.certificates[].keyAlg string    
certificateEnrollment.certificates[].keySource string    
certificateEnrollment.certificates[].names list    
certificateEnrollment.certificates[].names[] string    
certificateEnrollment.certificates[].notAfter string, or number    
certificateEnrollment.certificates[].notBefore string, or number    
certificateEnrollment.certificates[].profile string    
certificateEnrollment.certificates[].replaces string, or null    
certificateEnrollment.certificates[].requestedBy object    
certificateEnrollment.certificates[].requestedBy.admin boolean    
certificateEnrollment.certificates[].requestedBy.id string    
certificateEnrollment.certificates[].requestedBy.kind string    
certificateEnrollment.certificates[].revoked object    
certificateEnrollment.certificates[].revoked.at string, or number    
certificateEnrollment.certificates[].revoked.by string    
certificateEnrollment.certificates[].revoked.reason string    
certificateEnrollment.certificates[].serialHex string    
certificateEnrollment.certificates[].status string    
certificateEnrollment.certificates[].subject string    
certificateEnrollment.certificates[].thumbprint string    
certificateEnrollment.certificates[].via string    
certificateEnrollment.certificatesPaging object    
certificateEnrollment.certificatesPaging.firstRow integer    
certificateEnrollment.certificatesPaging.lastRow integer    
certificateEnrollment.certificatesPaging.noun string    
certificateEnrollment.certificatesPaging.page integer    
certificateEnrollment.certificatesPaging.pages integer    
certificateEnrollment.certificatesPaging.param string    
certificateEnrollment.certificatesPaging.perPage integer    
certificateEnrollment.certificatesPaging.total integer    
certificateEnrollment.certificatesTotal integer    
certificateEnrollment.eabKeys list    
certificateEnrollment.eabKeys[].boundAccount string, or null    
certificateEnrollment.eabKeys[].boundAt string, or number, or null    
certificateEnrollment.eabKeys[].createdAt string, or number    
certificateEnrollment.eabKeys[].createdBy string, or null    
certificateEnrollment.eabKeys[].expiresAt string, or number    
certificateEnrollment.eabKeys[].kid string    
certificateEnrollment.eabKeys[].status string    
certificateEnrollment.est object    
certificateEnrollment.est.basicAuthentication object    
certificateEnrollment.est.basicAuthentication.on boolean    
certificateEnrollment.est.basicAuthentication.source string    
certificateEnrollment.est.certificateAuthentication object    
certificateEnrollment.est.certificateAuthentication.on boolean    
certificateEnrollment.est.certificateAuthentication.source string    
certificateEnrollment.est.serverKeyGeneration object    
certificateEnrollment.est.serverKeyGeneration.on boolean    
certificateEnrollment.est.serverKeyGeneration.source string    
certificateEnrollment.families list    
certificateEnrollment.families[] string    
certificateEnrollment.hostNames list    
certificateEnrollment.hostNames[] string    
certificateEnrollment.rules list    
certificateEnrollment.rules[].allowedProfiles list    
certificateEnrollment.rules[].allowedProfiles[] string    
certificateEnrollment.rules[].allowedProfilesSource string    
certificateEnrollment.rules[].certificateLifetimeDays number    
certificateEnrollment.rules[].certificateLifetimeSource string    
certificateEnrollment.rules[].defaultProfile string, or null    
certificateEnrollment.rules[].defaultProfileSource string    
certificateEnrollment.rules[].family string    
certificateEnrollment.rules[].label string    
certificateEnrollment.scepChallenges list    
certificateEnrollment.scepChallenges[].createdAt string, or number    
certificateEnrollment.scepChallenges[].createdBy string, or null    
certificateEnrollment.scepChallenges[].expiresAt string, or number    
certificateEnrollment.scepChallenges[].id string    
certificateEnrollment.scepChallenges[].profile string, or null    
certificateEnrollment.scepChallenges[].status string    
certificateEnrollment.scepChallenges[].usedAt string, or number, or null    
claimSelections object    
claimSelections.catalogue list    
claimSelections.catalogue[].claim string    
claimSelections.catalogue[].generated boolean    
claimSelections.catalogue[].label string    
claimSelections.catalogue[].ldap string    
claimSelections.catalogue[].ldpTerm string    
claimSelections.catalogue[].schema string    
claimSelections.credential object    
claimSelections.credential.attribute string    
claimSelections.credential.claims map   The claims, by name.
claimSelections.credential.claims.{key} one of 2 shapes, or string, or number, or boolean, or null    
claimSelections.credential.claims.{key} (shape 1) list    
claimSelections.credential.claims.{key} (shape 1)[] string, or number, or boolean    
claimSelections.credential.claims.{key} (shape 2) map   A claim’s members, as address has.
claimSelections.credential.claims.{key} (shape 2).{key} list, or string, or number, or boolean, or null    
claimSelections.credential.claims.{key} (shape 2).{key}[] string, or number, or boolean    
claimSelections.credential.effective list    
claimSelections.credential.effective[] string    
claimSelections.credential.inherited boolean    
claimSelections.credential.ldpOmitted list    
claimSelections.credential.ldpOmitted[] string    
claimSelections.credential.own list    
claimSelections.credential.own[] string    
claimSelections.credential.realm list    
claimSelections.credential.realm[] string    
claimSelections.credential.report list    
claimSelections.credential.report[].claim string    
claimSelections.credential.report[].ldap string    
claimSelections.credential.report[].ldpTerm string, or null    
claimSelections.credential.report[].source string    
claimSelections.credential.report[].value list, or string, or number, or boolean, or null    
claimSelections.credential.report[].value[] string, or number, or boolean    
claimSelections.preview object    
claimSelections.preview.byLdap map   By lower-cased attribute name.
claimSelections.preview.byLdap.{key}.claim string    
claimSelections.preview.byLdap.{key}.ldap string    
claimSelections.preview.byLdap.{key}.ldpTerm string, or null    
claimSelections.preview.byLdap.{key}.source string    
claimSelections.preview.byLdap.{key}.value list, or string, or number, or boolean, or null    
claimSelections.preview.byLdap.{key}.value[] string, or number, or boolean    
claimSelections.preview.entryFound boolean    
claimSelections.preview.user string    
claimSelections.sets list    
claimSelections.sets[].attribute string    
claimSelections.sets[].claims map   The claims, by name.
claimSelections.sets[].claims.{key} one of 2 shapes, or string, or number, or boolean, or null    
claimSelections.sets[].claims.{key} (shape 1) list    
claimSelections.sets[].claims.{key} (shape 1)[] string, or number, or boolean    
claimSelections.sets[].claims.{key} (shape 2) map   A claim’s members, as address has.
claimSelections.sets[].claims.{key} (shape 2).{key} list, or string, or number, or boolean, or null    
claimSelections.sets[].claims.{key} (shape 2).{key}[] object   Nested deeper than this page draws.
claimSelections.sets[].effective list    
claimSelections.sets[].effective[] string    
claimSelections.sets[].id string    
claimSelections.sets[].inherited boolean    
claimSelections.sets[].label string    
claimSelections.sets[].own list    
claimSelections.sets[].own[] string    
claimSelections.sets[].realm list    
claimSelections.sets[].realm[] string    
claimSelections.sets[].report list    
claimSelections.sets[].report[].claim string    
claimSelections.sets[].report[].ldap string    
claimSelections.sets[].report[].ldpTerm string, or null    
claimSelections.sets[].report[].source string    
claimSelections.sets[].report[].value list, or string, or number, or boolean, or null    
claimSelections.sets[].report[].value[] string, or number, or boolean    
container string, or null    
createdAt string, or null    
credentials object    
credentials.caAvailable boolean    
credentials.clientSecret object    
credentials.clientSecret.authMethod string    
credentials.clientSecret.expiresAt number    
credentials.clientSecret.held boolean    
credentials.clientSecret.max number    
credentials.clientSecret.registered boolean    
credentials.clientSecret.registrationAccessTokenHeld boolean    
credentials.clientSecret.secrets list    
credentials.clientSecret.secrets[].createdAt number    
credentials.clientSecret.secrets[].description string, or null    
credentials.clientSecret.secrets[].expired boolean    
credentials.clientSecret.secrets[].expiresAt number    
credentials.clientSecret.secrets[].id string    
credentials.clientSecret.secrets[].primary boolean    
credentials.keyPairs list    
credentials.keyPairs[].attributes object    
credentials.keyPairs[].attributes.certificate string    
credentials.keyPairs[].attributes.chain string    
credentials.keyPairs[].attributes.expires string    
credentials.keyPairs[].attributes.handle string    
credentials.keyPairs[].attributes.handleLabel string    
credentials.keyPairs[].attributes.issuer string    
credentials.keyPairs[].attributes.jwks string    
credentials.keyPairs[].attributes.privateKey string    
credentials.keyPairs[].attributes.registered string    
credentials.keyPairs[].attributes.source string    
credentials.keyPairs[].certificate object    
credentials.keyPairs[].certificate.expired boolean    
credentials.keyPairs[].certificate.issuer string    
credentials.keyPairs[].certificate.keyType string, or null    
credentials.keyPairs[].certificate.notAfter string    
credentials.keyPairs[].certificate.notBefore string    
credentials.keyPairs[].certificate.selfSigned boolean    
credentials.keyPairs[].certificate.serialHex string    
credentials.keyPairs[].certificate.subject string    
credentials.keyPairs[].certificate.thumbprint string    
credentials.keyPairs[].certificate.unreadable string    
credentials.keyPairs[].chain list    
credentials.keyPairs[].chain[].expired boolean    
credentials.keyPairs[].chain[].issuer string    
credentials.keyPairs[].chain[].keyType string, or null    
credentials.keyPairs[].chain[].notAfter string    
credentials.keyPairs[].chain[].notBefore string    
credentials.keyPairs[].chain[].selfSigned boolean    
credentials.keyPairs[].chain[].serialHex string    
credentials.keyPairs[].chain[].subject string    
credentials.keyPairs[].chain[].thumbprint string    
credentials.keyPairs[].chain[].unreadable string    
credentials.keyPairs[].handle string    
credentials.keyPairs[].handleLabel string    
credentials.keyPairs[].held boolean    
credentials.keyPairs[].issuers list    
credentials.keyPairs[].issuers[] string    
credentials.keyPairs[].label string    
credentials.keyPairs[].privateKeyHeld boolean    
credentials.keyPairs[].purpose string    
credentials.keyPairs[].registered object    
credentials.keyPairs[].registered.attribute string    
credentials.keyPairs[].registered.certificates list    
credentials.keyPairs[].registered.certificates[].expired boolean    
credentials.keyPairs[].registered.certificates[].issuer string    
credentials.keyPairs[].registered.certificates[].keyType string, or null    
credentials.keyPairs[].registered.certificates[].notAfter string    
credentials.keyPairs[].registered.certificates[].notBefore string    
credentials.keyPairs[].registered.certificates[].selfSigned boolean    
credentials.keyPairs[].registered.certificates[].serialHex string    
credentials.keyPairs[].registered.certificates[].subject string    
credentials.keyPairs[].registered.certificates[].thumbprint string    
credentials.keyPairs[].registered.certificates[].unreadable string    
credentials.keyPairs[].registered.keys list    
credentials.keyPairs[].registered.keys[].alg string    
credentials.keyPairs[].registered.keys[].certificate object    
credentials.keyPairs[].registered.keys[].certificate.expired boolean    
credentials.keyPairs[].registered.keys[].certificate.issuer string    
credentials.keyPairs[].registered.keys[].certificate.keyType string, or null    
credentials.keyPairs[].registered.keys[].certificate.notAfter string    
credentials.keyPairs[].registered.keys[].certificate.notBefore string    
credentials.keyPairs[].registered.keys[].certificate.selfSigned boolean    
credentials.keyPairs[].registered.keys[].certificate.serialHex string    
credentials.keyPairs[].registered.keys[].certificate.subject string    
credentials.keyPairs[].registered.keys[].certificate.thumbprint string    
credentials.keyPairs[].registered.keys[].certificate.unreadable string    
credentials.keyPairs[].registered.keys[].kid string    
credentials.keyPairs[].registered.keys[].kty string    
credentials.keyPairs[].registered.keys[].use string    
credentials.keyPairs[].registered.problem string    
credentials.keyPairs[].source string    
credentials.mtls object    
credentials.mtls.active integer    
credentials.mtls.adminApiBound boolean    
credentials.mtls.authMethod string    
credentials.mtls.bindingAvailable boolean    
credentials.mtls.boundTokens boolean    
credentials.mtls.boundTokensAttribute string    
credentials.mtls.caAvailable boolean    
credentials.mtls.certificateMethod boolean    
credentials.mtls.certificates list    
credentials.mtls.certificates[].certificatePem string, or null    
credentials.mtls.certificates[].keyAlg string, or null    
credentials.mtls.certificates[].label string, or null    
credentials.mtls.certificates[].notAfter string, or number, or null    
credentials.mtls.certificates[].notBefore string, or number, or null    
credentials.mtls.certificates[].reason string, or null    
credentials.mtls.certificates[].revokedAt string, or number, or null    
credentials.mtls.certificates[].serialHex string    
credentials.mtls.certificates[].state string    
credentials.mtls.certificates[].subject string, or null    
credentials.mtls.certificates[].thumbprint string, or null    
credentials.mtls.defaultKeyAlg string    
credentials.mtls.implicitName string    
credentials.mtls.keyAlgorithms list    
credentials.mtls.keyAlgorithms[] string    
credentials.mtls.max number    
credentials.mtls.passwordMin number    
credentials.mtls.registeredSubject list    
credentials.mtls.registeredSubject[] string    
credentials.mtls.revocationReasons list    
credentials.mtls.revocationReasons[] string    
credentials.mtls.selfSignedThumbprint string    
credentials.mtls.subjects list    
credentials.mtls.subjects[].attribute string    
credentials.mtls.subjects[].label string    
credentials.mtls.subjects[].member string    
credentials.mtls.subjects[].value string    
credentials.oauthDeclared boolean    
credentials.signing object    
credentials.signing.active integer    
credentials.signing.caAvailable boolean    
credentials.signing.certificates list    
credentials.signing.certificates[].certificatePem string, or null    
credentials.signing.certificates[].keyAlg string, or null    
credentials.signing.certificates[].label string, or null    
credentials.signing.certificates[].notAfter string, or number, or null    
credentials.signing.certificates[].notBefore string, or number, or null    
credentials.signing.certificates[].reason string, or null    
credentials.signing.certificates[].revokedAt string, or number, or null    
credentials.signing.certificates[].serialHex string    
credentials.signing.certificates[].state string    
credentials.signing.certificates[].subject string, or null    
credentials.signing.certificates[].thumbprint string, or null    
credentials.signing.defaultKeyAlg string    
credentials.signing.holder string    
credentials.signing.implicitName string    
credentials.signing.keyAlgorithms list    
credentials.signing.keyAlgorithms[] string    
credentials.signing.kind string    
credentials.signing.max number    
credentials.signing.ok boolean    
credentials.signing.passwordMin number    
credentials.signing.revocationReasons list    
credentials.signing.revocationReasons[] string    
credentials.signing.wstrustDeclared boolean    
credentials.sources list    
credentials.sources[] string    
credentials.stored object    
credentials.stored.application string    
credentials.stored.certificates list    
credentials.stored.certificates[].expired boolean    
credentials.stored.certificates[].issuer string    
credentials.stored.certificates[].notAfter string    
credentials.stored.certificates[].notBefore string    
credentials.stored.certificates[].readable boolean    
credentials.stored.certificates[].serialNumber string    
credentials.stored.certificates[].sha256 string    
credentials.stored.certificates[].subject string    
credentials.stored.dn string, or null    
credentials.stored.errors list    
credentials.stored.errors[] string    
credentials.stored.ok boolean    
credentials.stored.rule string    
customClaims list    
customClaims[].attribute string    
customClaims[].effective list    
customClaims[].effective[].attribute string    
customClaims[].effective[].multi boolean    
customClaims[].effective[].name string    
customClaims[].effective[].nameFormat string    
customClaims[].effective[].namespace string    
customClaims[].effective[].replacesRealm boolean    
customClaims[].effective[].source string    
customClaims[].effective[].type string    
customClaims[].effective[].value list, or string, or number, or boolean, or null    
customClaims[].effective[].value[] string, or number, or boolean    
customClaims[].id string    
customClaims[].label string    
customClaims[].own list    
customClaims[].own[].attribute string    
customClaims[].own[].multi boolean    
customClaims[].own[].name string    
customClaims[].own[].nameFormat string    
customClaims[].own[].namespace string    
customClaims[].own[].type string    
customClaims[].own[].value list, or string, or number, or boolean, or null    
customClaims[].own[].value[] string, or number, or boolean    
customClaims[].realm list    
customClaims[].realm[].attribute string    
customClaims[].realm[].multi boolean    
customClaims[].realm[].name string    
customClaims[].realm[].nameFormat string    
customClaims[].realm[].namespace string    
customClaims[].realm[].type string    
customClaims[].realm[].value list, or string, or number, or boolean, or null    
customClaims[].realm[].value[] string, or number, or boolean    
declaredKinds list    
declaredKinds[] string    
delegatedPermissions object    
delegatedPermissions.exposes list    
delegatedPermissions.exposes[].baseUri string, or null    
delegatedPermissions.exposes[].description string, or null    
delegatedPermissions.exposes[].grantedTo list    
delegatedPermissions.exposes[].grantedTo[].asked boolean    
delegatedPermissions.exposes[].grantedTo[].identifier string    
delegatedPermissions.exposes[].grantedTo[].name string    
delegatedPermissions.exposes[].id string, or null    
delegatedPermissions.exposes[].name string    
delegatedPermissions.exposes[].raw string, or null    
delegatedPermissions.exposes[].resource string    
delegatedPermissions.exposes[].resourceName string    
delegatedPermissions.grantedOut list    
delegatedPermissions.grantedOut[].asked boolean    
delegatedPermissions.grantedOut[].baseUri string, or null    
delegatedPermissions.grantedOut[].client string    
delegatedPermissions.grantedOut[].clientName string    
delegatedPermissions.grantedOut[].dangling boolean    
delegatedPermissions.grantedOut[].description string, or null    
delegatedPermissions.grantedOut[].permissionId string    
delegatedPermissions.grantedOut[].permissionName string    
delegatedPermissions.grantedOut[].resource string    
delegatedPermissions.grantedOut[].resourceName string    
delegatedPermissions.held list    
delegatedPermissions.held[].asked boolean    
delegatedPermissions.held[].baseUri string, or null    
delegatedPermissions.held[].client string    
delegatedPermissions.held[].clientName string    
delegatedPermissions.held[].dangling boolean    
delegatedPermissions.held[].description string, or null    
delegatedPermissions.held[].permissionId string    
delegatedPermissions.held[].permissionName string    
delegatedPermissions.held[].resource string    
delegatedPermissions.held[].resourceName string    
delegatedPermissions.offerable list    
delegatedPermissions.offerable[] string, or null    
delegatedPermissions.paging object    
delegatedPermissions.paging.exposes object    
delegatedPermissions.paging.exposes.firstRow integer    
delegatedPermissions.paging.exposes.lastRow integer    
delegatedPermissions.paging.exposes.noun string    
delegatedPermissions.paging.exposes.page integer    
delegatedPermissions.paging.exposes.pages integer    
delegatedPermissions.paging.exposes.param string    
delegatedPermissions.paging.exposes.perPage integer    
delegatedPermissions.paging.exposes.total integer    
delegatedPermissions.paging.grantedOut object    
delegatedPermissions.paging.grantedOut.firstRow integer    
delegatedPermissions.paging.grantedOut.lastRow integer    
delegatedPermissions.paging.grantedOut.noun string    
delegatedPermissions.paging.grantedOut.page integer    
delegatedPermissions.paging.grantedOut.pages integer    
delegatedPermissions.paging.grantedOut.param string    
delegatedPermissions.paging.grantedOut.perPage integer    
delegatedPermissions.paging.grantedOut.total integer    
delegatedPermissions.paging.held object    
delegatedPermissions.paging.held.firstRow integer    
delegatedPermissions.paging.held.lastRow integer    
delegatedPermissions.paging.held.noun string    
delegatedPermissions.paging.held.page integer    
delegatedPermissions.paging.held.pages integer    
delegatedPermissions.paging.held.param string    
delegatedPermissions.paging.held.perPage integer    
delegatedPermissions.paging.held.total integer    
description string, or null    
dn string, or null    
dnLabel string, or null    
fields map   By attribute name.
fields.{key} list, or string, or number, or boolean, or null    
fields.{key}[] string, or number, or boolean    
filter object    
filter.exclude list    
filter.exclude[] string    
filter.kind string, or null    
filter.q string, or null    
firstRow integer    
firstSeen string    
found boolean    
identifier string    
kindCounts map   How many applications are of each kind.
kindCounts.{key} integer    
kinds list    
kinds[] object, or string    
kinds[].kind string    
kinds[].label string    
kinds[].what string    
lastRow integer    
lastSeen string    
matched integer    
max number, or null    
maxOwners number    
modifiedAt string, or null    
name string, or null    
operational list    
operational[] string    
origin string, or null    
owners list    
owners[].dn string    
owners[].kind string    
owners[].name string    
owners[].present boolean    
page object, or integer    
page.acceptsUnregisteredAddresses boolean    
page.accessTypes list    
page.accessTypes[].acr string    
page.accessTypes[].actions list    
page.accessTypes[].actions[] string    
page.accessTypes[].bearer list, or string, or number, or boolean, or null    
page.accessTypes[].bearer[] string, or number, or boolean    
page.accessTypes[].consentActions list    
page.accessTypes[].consentActions[] string    
page.accessTypes[].datatypes list    
page.accessTypes[].datatypes[] string    
page.accessTypes[].derivableFrom list    
page.accessTypes[].derivableFrom[] string    
page.accessTypes[].description string    
page.accessTypes[].interaction string    
page.accessTypes[].introspectionClaims list    
page.accessTypes[].introspectionClaims[] string    
page.accessTypes[].limits any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
page.accessTypes[].locations list    
page.accessTypes[].locations[] string    
page.accessTypes[].maxLifetimeS number, or null    
page.accessTypes[].notForPolicy list    
page.accessTypes[].notForPolicy[] string    
page.accessTypes[].privileges list    
page.accessTypes[].privileges[] string    
page.accessTypes[].problem string    
page.accessTypes[].required list    
page.accessTypes[].required[] string    
page.accessTypes[].schema any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
page.accessTypes[].source any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
page.accessTypes[].stored string    
page.accessTypes[].type string    
page.accessTypes[].validate null    
page.accessTypes[].validateLimits null    
page.accessTypes[].xacml list    
page.accessTypes[].xacml[].attributeId string    
page.accessTypes[].xacml[].category string    
page.accessTypes[].xacml[].dataType string    
page.accessTypes[].xacml[].description string    
page.accessTypes[].xacml[].multiplicity string    
page.accessTypes[].xacml[].path string    
page.claimSelections object    
page.claimSelections.catalogue list    
page.claimSelections.catalogue[].claim string    
page.claimSelections.catalogue[].generated boolean    
page.claimSelections.catalogue[].label string    
page.claimSelections.catalogue[].ldap string    
page.claimSelections.catalogue[].ldpTerm string    
page.claimSelections.catalogue[].schema string    
page.claimSelections.credential object    
page.claimSelections.credential.attribute string    
page.claimSelections.credential.claims map   The claims, by name.
page.claimSelections.credential.claims.{key} one of 2 shapes, or string, or number, or boolean, or null    
page.claimSelections.credential.claims.{key} (shape 1) list    
page.claimSelections.credential.claims.{key} (shape 1)[] string, or number, or boolean    
page.claimSelections.credential.claims.{key} (shape 2) map   A claim’s members, as address has.
page.claimSelections.credential.claims.{key} (shape 2).{key} object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.claimSelections.credential.effective list    
page.claimSelections.credential.effective[] string    
page.claimSelections.credential.inherited boolean    
page.claimSelections.credential.ldpOmitted list    
page.claimSelections.credential.ldpOmitted[] string    
page.claimSelections.credential.own list    
page.claimSelections.credential.own[] string    
page.claimSelections.credential.realm list    
page.claimSelections.credential.realm[] string    
page.claimSelections.credential.report list    
page.claimSelections.credential.report[].claim string    
page.claimSelections.credential.report[].ldap string    
page.claimSelections.credential.report[].ldpTerm string, or null    
page.claimSelections.credential.report[].source string    
page.claimSelections.credential.report[].value list, or string, or number, or boolean, or null    
page.claimSelections.credential.report[].value[] object   Nested deeper than this page draws.
page.claimSelections.preview object    
page.claimSelections.preview.byLdap map   By lower-cased attribute name.
page.claimSelections.preview.byLdap.{key}.claim string    
page.claimSelections.preview.byLdap.{key}.ldap string    
page.claimSelections.preview.byLdap.{key}.ldpTerm string, or null    
page.claimSelections.preview.byLdap.{key}.source string    
page.claimSelections.preview.byLdap.{key}.value list, or string, or number, or boolean, or null    
page.claimSelections.preview.byLdap.{key}.value[] object   Nested deeper than this page draws.
page.claimSelections.preview.entryFound boolean    
page.claimSelections.preview.user string    
page.claimSelections.sets list    
page.claimSelections.sets[].attribute string    
page.claimSelections.sets[].claims map   The claims, by name.
page.claimSelections.sets[].claims.{key} one of 2 shapes, or string, or number, or boolean, or null    
page.claimSelections.sets[].claims.{key} (shape 1) list    
page.claimSelections.sets[].claims.{key} (shape 1)[] object   Nested deeper than this page draws.
page.claimSelections.sets[].claims.{key} (shape 2) map   A claim’s members, as address has.
page.claimSelections.sets[].claims.{key} (shape 2).{key} object   Nested deeper than this page draws.
page.claimSelections.sets[].effective list    
page.claimSelections.sets[].effective[] string    
page.claimSelections.sets[].id string    
page.claimSelections.sets[].inherited boolean    
page.claimSelections.sets[].label string    
page.claimSelections.sets[].own list    
page.claimSelections.sets[].own[] string    
page.claimSelections.sets[].realm list    
page.claimSelections.sets[].realm[] string    
page.claimSelections.sets[].report list    
page.claimSelections.sets[].report[].claim string    
page.claimSelections.sets[].report[].ldap string    
page.claimSelections.sets[].report[].ldpTerm string, or null    
page.claimSelections.sets[].report[].source string    
page.claimSelections.sets[].report[].value object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.claims list    
page.claims[].attribute string    
page.claims[].effective list    
page.claims[].effective[].attribute string    
page.claims[].effective[].multi boolean    
page.claims[].effective[].name string    
page.claims[].effective[].nameFormat string    
page.claims[].effective[].namespace string    
page.claims[].effective[].replacesRealm boolean    
page.claims[].effective[].source string    
page.claims[].effective[].type string    
page.claims[].effective[].value list, or string, or number, or boolean, or null    
page.claims[].effective[].value[] object   Nested deeper than this page draws.
page.claims[].id string    
page.claims[].label string    
page.claims[].own list    
page.claims[].own[].attribute string    
page.claims[].own[].multi boolean    
page.claims[].own[].name string    
page.claims[].own[].nameFormat string    
page.claims[].own[].namespace string    
page.claims[].own[].type string    
page.claims[].own[].value list, or string, or number, or boolean, or null    
page.claims[].own[].value[] object   Nested deeper than this page draws.
page.claims[].realm list    
page.claims[].realm[].attribute string    
page.claims[].realm[].multi boolean    
page.claims[].realm[].name string    
page.claims[].realm[].nameFormat string    
page.claims[].realm[].namespace string    
page.claims[].realm[].type string    
page.claims[].realm[].value list, or string, or number, or boolean, or null    
page.claims[].realm[].value[] object   Nested deeper than this page draws.
page.config object    
page.config.derived object    
page.config.derived.oauthAllowedScope list    
page.config.derived.oauthAllowedScope[].api string    
page.config.derived.oauthAllowedScope[].apiName string    
page.config.derived.oauthAllowedScope[].permission string    
page.config.derived.oauthAllowedScope[].value string    
page.config.familyChoices list    
page.config.familyChoices[].families list    
page.config.familyChoices[].families[] string    
page.config.familyChoices[].id string    
page.config.familyChoices[].kind string    
page.config.familyChoices[].label string    
page.config.familyChoices[].what string    
page.config.fieldSearches map   What each attribute’s search looks through.
page.config.fieldSearches.{key} string    
page.config.fieldWarnings map   By attribute.
page.config.fieldWarnings.{key} list    
page.config.fieldWarnings.{key}[].attribute string    
page.config.fieldWarnings.{key}[].dropped boolean    
page.config.fieldWarnings.{key}[].reason string    
page.config.fieldWarnings.{key}[].text string    
page.config.fieldWarnings.{key}[].value string    
page.config.fields list    
page.config.fields[].attribute string    
page.config.fields[].choices list    
page.config.fields[].choices[] string    
page.config.fields[].declaration boolean    
page.config.fields[].described object    
page.config.fields[].described.appconfigPath string    
page.config.fields[].described.csvValueNotes map   The sentence beside each of a list’s values.
page.config.fields[].described.csvValueNotes.{key} string    
page.config.fields[].described.csvValues list    
page.config.fields[].described.csvValues[] string    
page.config.fields[].described.default list, or string, or number, or boolean, or null    
page.config.fields[].described.default[] object   Nested deeper than this page draws.
page.config.fields[].described.description string    
page.config.fields[].described.editRefusal string    
page.config.fields[].described.editable boolean    
page.config.fields[].described.enumValues list    
page.config.fields[].described.enumValues[] string    
page.config.fields[].described.env string, or null    
page.config.fields[].described.group string    
page.config.fields[].described.key string    
page.config.fields[].described.label string    
page.config.fields[].described.legacyEnv string, or null    
page.config.fields[].described.masked boolean    
page.config.fields[].described.max number    
page.config.fields[].described.min number    
page.config.fields[].described.ordered boolean    
page.config.fields[].described.overridden boolean    
page.config.fields[].described.realmSettable boolean    
page.config.fields[].described.restartReason string    
page.config.fields[].described.selectAll object    
page.config.fields[].described.selectAll.aloneWhileOn list    
page.config.fields[].described.selectAll.aloneWhileOn[] object   Nested deeper than this page draws.
page.config.fields[].described.selectAll.onlyWhileOn list    
page.config.fields[].described.selectAll.onlyWhileOn[] object   Nested deeper than this page draws.
page.config.fields[].described.source string    
page.config.fields[].described.step number    
page.config.fields[].described.text string    
page.config.fields[].described.type string    
page.config.fields[].described.value list, or string, or number, or boolean, or null    
page.config.fields[].described.value[] object   Nested deeper than this page draws.
page.config.fields[].editable string, or boolean    
page.config.fields[].everyFamily boolean    
page.config.fields[].example string, or null    
page.config.fields[].families list    
page.config.fields[].families[] string    
page.config.fields[].group string    
page.config.fields[].inSimple boolean    
page.config.fields[].long boolean    
page.config.fields[].overrides string    
page.config.fields[].primaryName boolean    
page.config.fields[].section string    
page.config.fields[].sectionLabel string    
page.config.fields[].sensitive boolean    
page.config.fields[].simple boolean    
page.config.fields[].type string    
page.config.fields[].what string    
page.config.groups list    
page.config.groups[].families list    
page.config.groups[].families[] string    
page.config.groups[].id string    
page.config.groups[].label string    
page.config.longTextAttributes list    
page.config.longTextAttributes[] string    
page.config.observed object    
page.config.observed.appAuthorizationServer list    
page.config.observed.appAuthorizationServer[].declared boolean    
page.config.observed.appAuthorizationServer[].value string    
page.config.observed.appRedirectUriObserved list    
page.config.observed.appRedirectUriObserved[].declared boolean    
page.config.observed.appRedirectUriObserved[].value string    
page.config.observed.oauthAllowedTokenResponseTypes object    
page.config.observed.oauthAllowedTokenResponseTypes.enabled list    
page.config.observed.oauthAllowedTokenResponseTypes.enabled[] string    
page.config.observed.oauthAllowedTokenResponseTypes.enforced boolean    
page.config.observed.oauthAllowedTokenResponseTypes.waived boolean    
page.config.observed.oauthGrantTypeObserved list    
page.config.observed.oauthGrantTypeObserved[].declared boolean    
page.config.observed.oauthGrantTypeObserved[].value string    
page.config.observed.oauthResponseTypeObserved list    
page.config.observed.oauthResponseTypeObserved[].declared boolean    
page.config.observed.oauthResponseTypeObserved[].value string    
page.config.observed.oauthScope list    
page.config.observed.oauthScope[].declared boolean    
page.config.observed.oauthScope[].value string    
page.config.observed.samlLastRequest object    
page.config.observed.samlLastRequest.binding string    
page.config.observed.samlLastRequest.outcome string    
page.config.observed.samlLastRequest.signatureMethod string    
page.config.observed.samlLastRequest.signed boolean    
page.config.observed.samlLastRequest.weak boolean    
page.config.observed.samlNameIdFormat list    
page.config.observed.samlNameIdFormat[].declared boolean    
page.config.observed.samlNameIdFormat[].value string    
page.config.observed.samlObservedSigningCertificate object    
page.config.observed.samlObservedSigningCertificate.sha256 string    
page.config.observed.samlObservedSigningCertificate.subject string    
page.config.observed.samlObservedSigningCertificate.unreadable boolean    
page.config.observed.samlResponseBinding list    
page.config.observed.samlResponseBinding[].declared boolean    
page.config.observed.samlResponseBinding[].value string    
page.config.protocols list    
page.config.protocols[].deliveryAttribute string    
page.config.protocols[].eventsAttribute string    
page.config.protocols[].id string    
page.config.protocols[].identifierAttribute string    
page.config.protocols[].kind string    
page.config.protocols[].kinds list    
page.config.protocols[].kinds[] string    
page.config.protocols[].label string    
page.config.protocols[].logoutAttribute string    
page.config.protocols[].redirectAttribute string    
page.config.protocols[].secretAttribute string    
page.config.protocols[].what string    
page.config.values map   Each field’s values, by attribute.
page.config.values.{key} list    
page.config.values.{key}[] string    
page.cors list    
page.cors[].canonical string    
page.cors[].stored string    
page.credentials object    
page.credentials.ca object    
page.credentials.ca.available boolean    
page.credentials.ca.keyAlg string    
page.credentials.ca.keyAlgorithms list    
page.credentials.ca.keyAlgorithms[].id string    
page.credentials.ca.keyAlgorithms[].kind string    
page.credentials.ca.keyAlgorithms[].label string    
page.credentials.ca.leafLifetimeDays number    
page.credentials.clientSecret object    
page.credentials.clientSecret.authMethod string    
page.credentials.clientSecret.defaultLifetimeDays number    
page.credentials.clientSecret.expiresAt number    
page.credentials.clientSecret.held boolean    
page.credentials.clientSecret.max number    
page.credentials.clientSecret.overlapS number    
page.credentials.clientSecret.registered boolean    
page.credentials.clientSecret.registrationAccessTokenHeld boolean    
page.credentials.clientSecret.secrets list    
page.credentials.clientSecret.secrets[].createdAt number    
page.credentials.clientSecret.secrets[].description string, or null    
page.credentials.clientSecret.secrets[].expired boolean    
page.credentials.clientSecret.secrets[].expiresAt number    
page.credentials.clientSecret.secrets[].id string    
page.credentials.clientSecret.secrets[].primary boolean    
page.credentials.mtls object    
page.credentials.mtls.active integer    
page.credentials.mtls.adminApiBound boolean    
page.credentials.mtls.authMethod string    
page.credentials.mtls.bindingAvailable boolean    
page.credentials.mtls.boundTokens boolean    
page.credentials.mtls.boundTokensAttribute string    
page.credentials.mtls.caAvailable boolean    
page.credentials.mtls.certificateMethod boolean    
page.credentials.mtls.certificates list    
page.credentials.mtls.certificates[].certificatePem string, or null    
page.credentials.mtls.certificates[].keyAlg string, or null    
page.credentials.mtls.certificates[].label string, or null    
page.credentials.mtls.certificates[].notAfter string, or number, or null    
page.credentials.mtls.certificates[].notBefore string, or number, or null    
page.credentials.mtls.certificates[].reason string, or null    
page.credentials.mtls.certificates[].revokedAt string, or number, or null    
page.credentials.mtls.certificates[].serialHex string    
page.credentials.mtls.certificates[].state string    
page.credentials.mtls.certificates[].subject string, or null    
page.credentials.mtls.certificates[].thumbprint string, or null    
page.credentials.mtls.defaultKeyAlg string    
page.credentials.mtls.implicitName string    
page.credentials.mtls.keyAlgorithms list    
page.credentials.mtls.keyAlgorithms[] string    
page.credentials.mtls.max number    
page.credentials.mtls.passwordMin number    
page.credentials.mtls.registeredSubject list    
page.credentials.mtls.registeredSubject[] string    
page.credentials.mtls.revocationReasons list    
page.credentials.mtls.revocationReasons[] string    
page.credentials.mtls.selfSignedThumbprint string    
page.credentials.mtls.subjects list    
page.credentials.mtls.subjects[].attribute string    
page.credentials.mtls.subjects[].label string    
page.credentials.mtls.subjects[].member string    
page.credentials.mtls.subjects[].value string    
page.credentials.oauthDeclared boolean    
page.credentials.purposes list    
page.credentials.purposes[].attributes object    
page.credentials.purposes[].attributes.certificate string    
page.credentials.purposes[].attributes.chain string    
page.credentials.purposes[].attributes.expires string    
page.credentials.purposes[].attributes.handle string    
page.credentials.purposes[].attributes.handleLabel string    
page.credentials.purposes[].attributes.issuer string    
page.credentials.purposes[].attributes.jwks string    
page.credentials.purposes[].attributes.privateKey string    
page.credentials.purposes[].attributes.registered string    
page.credentials.purposes[].attributes.source string    
page.credentials.purposes[].certificate object    
page.credentials.purposes[].certificate.expired boolean    
page.credentials.purposes[].certificate.issuer string    
page.credentials.purposes[].certificate.keyType string, or null    
page.credentials.purposes[].certificate.notAfter string    
page.credentials.purposes[].certificate.notBefore string    
page.credentials.purposes[].certificate.selfSigned boolean    
page.credentials.purposes[].certificate.serialHex string    
page.credentials.purposes[].certificate.subject string    
page.credentials.purposes[].certificate.thumbprint string    
page.credentials.purposes[].certificate.unreadable string    
page.credentials.purposes[].certificatePem string    
page.credentials.purposes[].chain list    
page.credentials.purposes[].chain[].expired boolean    
page.credentials.purposes[].chain[].issuer string    
page.credentials.purposes[].chain[].keyType string, or null    
page.credentials.purposes[].chain[].notAfter string    
page.credentials.purposes[].chain[].notBefore string    
page.credentials.purposes[].chain[].selfSigned boolean    
page.credentials.purposes[].chain[].serialHex string    
page.credentials.purposes[].chain[].subject string    
page.credentials.purposes[].chain[].thumbprint string    
page.credentials.purposes[].chain[].unreadable string    
page.credentials.purposes[].handle string    
page.credentials.purposes[].handleLabel string    
page.credentials.purposes[].held boolean    
page.credentials.purposes[].id string    
page.credentials.purposes[].issuers list    
page.credentials.purposes[].issuers[] string    
page.credentials.purposes[].label string    
page.credentials.purposes[].privateKeyHeld boolean    
page.credentials.purposes[].registered object    
page.credentials.purposes[].registered.attribute string    
page.credentials.purposes[].registered.certificates list    
page.credentials.purposes[].registered.certificates[].expired object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].issuer object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].keyType object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].notAfter object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].notBefore object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].selfSigned object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].serialHex object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].subject object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].thumbprint object   Nested deeper than this page draws.
page.credentials.purposes[].registered.certificates[].unreadable object   Nested deeper than this page draws.
page.credentials.purposes[].registered.keys list    
page.credentials.purposes[].registered.keys[].alg object   Nested deeper than this page draws.
page.credentials.purposes[].registered.keys[].certificate object   Nested deeper than this page draws.
page.credentials.purposes[].registered.keys[].kid object   Nested deeper than this page draws.
page.credentials.purposes[].registered.keys[].kty object   Nested deeper than this page draws.
page.credentials.purposes[].registered.keys[].use object   Nested deeper than this page draws.
page.credentials.purposes[].registered.problem string    
page.credentials.purposes[].sealedAtRest boolean    
page.credentials.purposes[].source string    
page.credentials.signing object    
page.credentials.signing.active integer    
page.credentials.signing.caAvailable boolean    
page.credentials.signing.certificates list    
page.credentials.signing.certificates[].certificatePem string, or null    
page.credentials.signing.certificates[].keyAlg string, or null    
page.credentials.signing.certificates[].label string, or null    
page.credentials.signing.certificates[].notAfter string, or number, or null    
page.credentials.signing.certificates[].notBefore string, or number, or null    
page.credentials.signing.certificates[].reason string, or null    
page.credentials.signing.certificates[].revokedAt string, or number, or null    
page.credentials.signing.certificates[].serialHex string    
page.credentials.signing.certificates[].state string    
page.credentials.signing.certificates[].subject string, or null    
page.credentials.signing.certificates[].thumbprint string, or null    
page.credentials.signing.defaultKeyAlg string    
page.credentials.signing.holder string    
page.credentials.signing.implicitName string    
page.credentials.signing.keyAlgorithms list    
page.credentials.signing.keyAlgorithms[] string    
page.credentials.signing.kind string    
page.credentials.signing.max number    
page.credentials.signing.ok boolean    
page.credentials.signing.passwordMin number    
page.credentials.signing.revocationReasons list    
page.credentials.signing.revocationReasons[] string    
page.credentials.signing.wstrustDeclared boolean    
page.credentials.sources list    
page.credentials.sources[] string    
page.credentials.stored object    
page.credentials.stored.application string    
page.credentials.stored.certificates list    
page.credentials.stored.certificates[].expired boolean    
page.credentials.stored.certificates[].issuer string    
page.credentials.stored.certificates[].notAfter string    
page.credentials.stored.certificates[].notBefore string    
page.credentials.stored.certificates[].readable boolean    
page.credentials.stored.certificates[].serialNumber string    
page.credentials.stored.certificates[].sha256 string    
page.credentials.stored.certificates[].subject string    
page.credentials.stored.dn string, or null    
page.credentials.stored.errors list    
page.credentials.stored.errors[] string    
page.credentials.stored.ok boolean    
page.credentials.stored.rule string    
page.did object    
page.did.did string, or null    
page.did.methods list    
page.did.methods[].alg string    
page.did.methods[].crv string    
page.did.methods[].kept boolean    
page.did.methods[].kid string    
page.did.methods[].kty string    
page.did.ok boolean    
page.did.origins list    
page.did.origins[] string    
page.did.url string    
page.did.why string    
page.editable object    
page.editable.multi list    
page.editable.multi[].name string    
page.editable.multi[].sensitive boolean    
page.editable.multiAll list    
page.editable.multiAll[].name string    
page.editable.multiAll[].sensitive boolean    
page.editable.set list    
page.editable.set[].name string    
page.editable.set[].sensitive boolean    
page.enrollment object    
page.enrollment.config object    
page.enrollment.config.cap object    
page.enrollment.config.cap.source string    
page.enrollment.config.cap.value number    
page.enrollment.config.certificates list    
page.enrollment.config.certificates[].attestation list, or string, or number, or boolean, or null    
page.enrollment.config.certificates[].attestation[] object   Nested deeper than this page draws.
page.enrollment.config.certificates[].certificatePem string    
page.enrollment.config.certificates[].chainPem list    
page.enrollment.config.certificates[].chainPem[] string    
page.enrollment.config.certificates[].device string    
page.enrollment.config.certificates[].expired boolean    
page.enrollment.config.certificates[].family string    
page.enrollment.config.certificates[].issuedAt string    
page.enrollment.config.certificates[].keyAlg string    
page.enrollment.config.certificates[].keySource string    
page.enrollment.config.certificates[].names list    
page.enrollment.config.certificates[].names[] string    
page.enrollment.config.certificates[].notAfter string, or number    
page.enrollment.config.certificates[].notBefore string, or number    
page.enrollment.config.certificates[].profile string    
page.enrollment.config.certificates[].replaces string, or null    
page.enrollment.config.certificates[].requestedBy object    
page.enrollment.config.certificates[].requestedBy.admin boolean    
page.enrollment.config.certificates[].requestedBy.id string    
page.enrollment.config.certificates[].requestedBy.kind string    
page.enrollment.config.certificates[].revoked object    
page.enrollment.config.certificates[].revoked.at string, or number    
page.enrollment.config.certificates[].revoked.by string    
page.enrollment.config.certificates[].revoked.reason string    
page.enrollment.config.certificates[].serialHex string    
page.enrollment.config.certificates[].status string    
page.enrollment.config.certificates[].subject string    
page.enrollment.config.certificates[].thumbprint string    
page.enrollment.config.certificates[].via string    
page.enrollment.config.challenges list    
page.enrollment.config.challenges[].createdAt string, or number    
page.enrollment.config.challenges[].createdBy string, or null    
page.enrollment.config.challenges[].expiresAt string, or number    
page.enrollment.config.challenges[].id string    
page.enrollment.config.challenges[].profile string, or null    
page.enrollment.config.challenges[].status string    
page.enrollment.config.challenges[].usedAt string, or number, or null    
page.enrollment.config.eabKeys list    
page.enrollment.config.eabKeys[].boundAccount string, or null    
page.enrollment.config.eabKeys[].boundAt string, or number, or null    
page.enrollment.config.eabKeys[].createdAt string, or number    
page.enrollment.config.eabKeys[].createdBy string, or null    
page.enrollment.config.eabKeys[].expiresAt string, or number    
page.enrollment.config.eabKeys[].kid string    
page.enrollment.config.eabKeys[].status string    
page.enrollment.config.est object    
page.enrollment.config.est.basicAuthentication object    
page.enrollment.config.est.basicAuthentication.on boolean    
page.enrollment.config.est.basicAuthentication.source string    
page.enrollment.config.est.certificateAuthentication object    
page.enrollment.config.est.certificateAuthentication.on boolean    
page.enrollment.config.est.certificateAuthentication.source string    
page.enrollment.config.est.serverKeyGeneration object    
page.enrollment.config.est.serverKeyGeneration.on boolean    
page.enrollment.config.est.serverKeyGeneration.source string    
page.enrollment.config.families list    
page.enrollment.config.families[] string    
page.enrollment.config.hostNames list    
page.enrollment.config.hostNames[] string    
page.enrollment.config.json object    
page.enrollment.config.json.certificateCap object    
page.enrollment.config.json.certificateCap.source string    
page.enrollment.config.json.certificateCap.value number    
page.enrollment.config.json.certificates list    
page.enrollment.config.json.certificates[].attestation object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].certificatePem string    
page.enrollment.config.json.certificates[].chainPem list    
page.enrollment.config.json.certificates[].chainPem[] object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].device string    
page.enrollment.config.json.certificates[].expired boolean    
page.enrollment.config.json.certificates[].family string    
page.enrollment.config.json.certificates[].issuedAt string    
page.enrollment.config.json.certificates[].keyAlg string    
page.enrollment.config.json.certificates[].keySource string    
page.enrollment.config.json.certificates[].names list    
page.enrollment.config.json.certificates[].names[] object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].notAfter string, or number    
page.enrollment.config.json.certificates[].notBefore string, or number    
page.enrollment.config.json.certificates[].profile string    
page.enrollment.config.json.certificates[].replaces string, or null    
page.enrollment.config.json.certificates[].requestedBy object    
page.enrollment.config.json.certificates[].requestedBy.admin object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].requestedBy.id object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].requestedBy.kind object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].revoked object    
page.enrollment.config.json.certificates[].revoked.at object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].revoked.by object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].revoked.reason object   Nested deeper than this page draws.
page.enrollment.config.json.certificates[].serialHex string    
page.enrollment.config.json.certificates[].status string    
page.enrollment.config.json.certificates[].subject string    
page.enrollment.config.json.certificates[].thumbprint string    
page.enrollment.config.json.certificates[].via string    
page.enrollment.config.json.certificatesPaging object    
page.enrollment.config.json.certificatesPaging.firstRow integer    
page.enrollment.config.json.certificatesPaging.lastRow integer    
page.enrollment.config.json.certificatesPaging.noun string    
page.enrollment.config.json.certificatesPaging.page integer    
page.enrollment.config.json.certificatesPaging.pages integer    
page.enrollment.config.json.certificatesPaging.param string    
page.enrollment.config.json.certificatesPaging.perPage integer    
page.enrollment.config.json.certificatesPaging.total integer    
page.enrollment.config.json.certificatesTotal integer    
page.enrollment.config.json.eabKeys list    
page.enrollment.config.json.eabKeys[].boundAccount string, or null    
page.enrollment.config.json.eabKeys[].boundAt string, or number, or null    
page.enrollment.config.json.eabKeys[].createdAt string, or number    
page.enrollment.config.json.eabKeys[].createdBy string, or null    
page.enrollment.config.json.eabKeys[].expiresAt string, or number    
page.enrollment.config.json.eabKeys[].kid string    
page.enrollment.config.json.eabKeys[].status string    
page.enrollment.config.json.est object    
page.enrollment.config.json.est.basicAuthentication object    
page.enrollment.config.json.est.basicAuthentication.on boolean    
page.enrollment.config.json.est.basicAuthentication.source string    
page.enrollment.config.json.est.certificateAuthentication object    
page.enrollment.config.json.est.certificateAuthentication.on boolean    
page.enrollment.config.json.est.certificateAuthentication.source string    
page.enrollment.config.json.est.serverKeyGeneration object    
page.enrollment.config.json.est.serverKeyGeneration.on boolean    
page.enrollment.config.json.est.serverKeyGeneration.source string    
page.enrollment.config.json.families list    
page.enrollment.config.json.families[] string    
page.enrollment.config.json.hostNames list    
page.enrollment.config.json.hostNames[] string    
page.enrollment.config.json.rules list    
page.enrollment.config.json.rules[].allowedProfiles list    
page.enrollment.config.json.rules[].allowedProfiles[] object   Nested deeper than this page draws.
page.enrollment.config.json.rules[].allowedProfilesSource string    
page.enrollment.config.json.rules[].certificateLifetimeDays number    
page.enrollment.config.json.rules[].certificateLifetimeSource string    
page.enrollment.config.json.rules[].defaultProfile string, or null    
page.enrollment.config.json.rules[].defaultProfileSource string    
page.enrollment.config.json.rules[].family string    
page.enrollment.config.json.rules[].label string    
page.enrollment.config.json.scepChallenges list    
page.enrollment.config.json.scepChallenges[].createdAt string, or number    
page.enrollment.config.json.scepChallenges[].createdBy string, or null    
page.enrollment.config.json.scepChallenges[].expiresAt string, or number    
page.enrollment.config.json.scepChallenges[].id string    
page.enrollment.config.json.scepChallenges[].profile string, or null    
page.enrollment.config.json.scepChallenges[].status string    
page.enrollment.config.json.scepChallenges[].usedAt string, or number, or null    
page.enrollment.config.keyAlgorithms list    
page.enrollment.config.keyAlgorithms[] string    
page.enrollment.config.paged object    
page.enrollment.config.paged.paging object    
page.enrollment.config.paged.paging.firstRow integer    
page.enrollment.config.paged.paging.lastRow integer    
page.enrollment.config.paged.paging.noun string    
page.enrollment.config.paged.paging.offset integer    
page.enrollment.config.paged.paging.page integer    
page.enrollment.config.paged.paging.pages integer    
page.enrollment.config.paged.paging.param string    
page.enrollment.config.paged.paging.perPage integer    
page.enrollment.config.paged.paging.total integer    
page.enrollment.config.paged.shown list    
page.enrollment.config.paged.shown[].attestation object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].certificatePem string    
page.enrollment.config.paged.shown[].chainPem list    
page.enrollment.config.paged.shown[].chainPem[] object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].device string    
page.enrollment.config.paged.shown[].expired boolean    
page.enrollment.config.paged.shown[].family string    
page.enrollment.config.paged.shown[].issuedAt string    
page.enrollment.config.paged.shown[].keyAlg string    
page.enrollment.config.paged.shown[].keySource string    
page.enrollment.config.paged.shown[].names list    
page.enrollment.config.paged.shown[].names[] object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].notAfter string, or number    
page.enrollment.config.paged.shown[].notBefore string, or number    
page.enrollment.config.paged.shown[].profile string    
page.enrollment.config.paged.shown[].replaces string, or null    
page.enrollment.config.paged.shown[].requestedBy object    
page.enrollment.config.paged.shown[].requestedBy.admin object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].requestedBy.id object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].requestedBy.kind object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].revoked object    
page.enrollment.config.paged.shown[].revoked.at object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].revoked.by object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].revoked.reason object   Nested deeper than this page draws.
page.enrollment.config.paged.shown[].serialHex string    
page.enrollment.config.paged.shown[].status string    
page.enrollment.config.paged.shown[].subject string    
page.enrollment.config.paged.shown[].thumbprint string    
page.enrollment.config.paged.shown[].via string    
page.enrollment.config.rules list    
page.enrollment.config.rules[].allowedProfiles list    
page.enrollment.config.rules[].allowedProfiles[] string    
page.enrollment.config.rules[].allowedProfilesSource string    
page.enrollment.config.rules[].certificateLifetimeDays number    
page.enrollment.config.rules[].certificateLifetimeSource string    
page.enrollment.config.rules[].defaultProfile string, or null    
page.enrollment.config.rules[].defaultProfileSource string    
page.enrollment.config.rules[].family string    
page.enrollment.config.rules[].label string    
page.enrollment.credentials object    
page.enrollment.credentials.cap object    
page.enrollment.credentials.cap.source string    
page.enrollment.credentials.cap.value number    
page.enrollment.credentials.certificates list    
page.enrollment.credentials.certificates[].attestation list, or string, or number, or boolean, or null    
page.enrollment.credentials.certificates[].attestation[] object   Nested deeper than this page draws.
page.enrollment.credentials.certificates[].certificatePem string    
page.enrollment.credentials.certificates[].chainPem list    
page.enrollment.credentials.certificates[].chainPem[] string    
page.enrollment.credentials.certificates[].device string    
page.enrollment.credentials.certificates[].expired boolean    
page.enrollment.credentials.certificates[].family string    
page.enrollment.credentials.certificates[].issuedAt string    
page.enrollment.credentials.certificates[].keyAlg string    
page.enrollment.credentials.certificates[].keySource string    
page.enrollment.credentials.certificates[].names list    
page.enrollment.credentials.certificates[].names[] string    
page.enrollment.credentials.certificates[].notAfter string, or number    
page.enrollment.credentials.certificates[].notBefore string, or number    
page.enrollment.credentials.certificates[].profile string    
page.enrollment.credentials.certificates[].replaces string, or null    
page.enrollment.credentials.certificates[].requestedBy object    
page.enrollment.credentials.certificates[].requestedBy.admin boolean    
page.enrollment.credentials.certificates[].requestedBy.id string    
page.enrollment.credentials.certificates[].requestedBy.kind string    
page.enrollment.credentials.certificates[].revoked object    
page.enrollment.credentials.certificates[].revoked.at string, or number    
page.enrollment.credentials.certificates[].revoked.by string    
page.enrollment.credentials.certificates[].revoked.reason string    
page.enrollment.credentials.certificates[].serialHex string    
page.enrollment.credentials.certificates[].status string    
page.enrollment.credentials.certificates[].subject string    
page.enrollment.credentials.certificates[].thumbprint string    
page.enrollment.credentials.certificates[].via string    
page.enrollment.credentials.challenges list    
page.enrollment.credentials.challenges[].createdAt string, or number    
page.enrollment.credentials.challenges[].createdBy string, or null    
page.enrollment.credentials.challenges[].expiresAt string, or number    
page.enrollment.credentials.challenges[].id string    
page.enrollment.credentials.challenges[].profile string, or null    
page.enrollment.credentials.challenges[].status string    
page.enrollment.credentials.challenges[].usedAt string, or number, or null    
page.enrollment.credentials.eabKeys list    
page.enrollment.credentials.eabKeys[].boundAccount string, or null    
page.enrollment.credentials.eabKeys[].boundAt string, or number, or null    
page.enrollment.credentials.eabKeys[].createdAt string, or number    
page.enrollment.credentials.eabKeys[].createdBy string, or null    
page.enrollment.credentials.eabKeys[].expiresAt string, or number    
page.enrollment.credentials.eabKeys[].kid string    
page.enrollment.credentials.eabKeys[].status string    
page.enrollment.credentials.est object    
page.enrollment.credentials.est.basicAuthentication object    
page.enrollment.credentials.est.basicAuthentication.on boolean    
page.enrollment.credentials.est.basicAuthentication.source string    
page.enrollment.credentials.est.certificateAuthentication object    
page.enrollment.credentials.est.certificateAuthentication.on boolean    
page.enrollment.credentials.est.certificateAuthentication.source string    
page.enrollment.credentials.est.serverKeyGeneration object    
page.enrollment.credentials.est.serverKeyGeneration.on boolean    
page.enrollment.credentials.est.serverKeyGeneration.source string    
page.enrollment.credentials.families list    
page.enrollment.credentials.families[] string    
page.enrollment.credentials.hostNames list    
page.enrollment.credentials.hostNames[] string    
page.enrollment.credentials.json object    
page.enrollment.credentials.json.certificateCap object    
page.enrollment.credentials.json.certificateCap.source string    
page.enrollment.credentials.json.certificateCap.value number    
page.enrollment.credentials.json.certificates list    
page.enrollment.credentials.json.certificates[].attestation object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].certificatePem string    
page.enrollment.credentials.json.certificates[].chainPem list    
page.enrollment.credentials.json.certificates[].chainPem[] object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].device string    
page.enrollment.credentials.json.certificates[].expired boolean    
page.enrollment.credentials.json.certificates[].family string    
page.enrollment.credentials.json.certificates[].issuedAt string    
page.enrollment.credentials.json.certificates[].keyAlg string    
page.enrollment.credentials.json.certificates[].keySource string    
page.enrollment.credentials.json.certificates[].names list    
page.enrollment.credentials.json.certificates[].names[] object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].notAfter string, or number    
page.enrollment.credentials.json.certificates[].notBefore string, or number    
page.enrollment.credentials.json.certificates[].profile string    
page.enrollment.credentials.json.certificates[].replaces string, or null    
page.enrollment.credentials.json.certificates[].requestedBy object    
page.enrollment.credentials.json.certificates[].requestedBy.admin object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].requestedBy.id object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].requestedBy.kind object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].revoked object    
page.enrollment.credentials.json.certificates[].revoked.at object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].revoked.by object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].revoked.reason object   Nested deeper than this page draws.
page.enrollment.credentials.json.certificates[].serialHex string    
page.enrollment.credentials.json.certificates[].status string    
page.enrollment.credentials.json.certificates[].subject string    
page.enrollment.credentials.json.certificates[].thumbprint string    
page.enrollment.credentials.json.certificates[].via string    
page.enrollment.credentials.json.certificatesPaging object    
page.enrollment.credentials.json.certificatesPaging.firstRow integer    
page.enrollment.credentials.json.certificatesPaging.lastRow integer    
page.enrollment.credentials.json.certificatesPaging.noun string    
page.enrollment.credentials.json.certificatesPaging.page integer    
page.enrollment.credentials.json.certificatesPaging.pages integer    
page.enrollment.credentials.json.certificatesPaging.param string    
page.enrollment.credentials.json.certificatesPaging.perPage integer    
page.enrollment.credentials.json.certificatesPaging.total integer    
page.enrollment.credentials.json.certificatesTotal integer    
page.enrollment.credentials.json.eabKeys list    
page.enrollment.credentials.json.eabKeys[].boundAccount string, or null    
page.enrollment.credentials.json.eabKeys[].boundAt string, or number, or null    
page.enrollment.credentials.json.eabKeys[].createdAt string, or number    
page.enrollment.credentials.json.eabKeys[].createdBy string, or null    
page.enrollment.credentials.json.eabKeys[].expiresAt string, or number    
page.enrollment.credentials.json.eabKeys[].kid string    
page.enrollment.credentials.json.eabKeys[].status string    
page.enrollment.credentials.json.est object    
page.enrollment.credentials.json.est.basicAuthentication object    
page.enrollment.credentials.json.est.basicAuthentication.on boolean    
page.enrollment.credentials.json.est.basicAuthentication.source string    
page.enrollment.credentials.json.est.certificateAuthentication object    
page.enrollment.credentials.json.est.certificateAuthentication.on boolean    
page.enrollment.credentials.json.est.certificateAuthentication.source string    
page.enrollment.credentials.json.est.serverKeyGeneration object    
page.enrollment.credentials.json.est.serverKeyGeneration.on boolean    
page.enrollment.credentials.json.est.serverKeyGeneration.source string    
page.enrollment.credentials.json.families list    
page.enrollment.credentials.json.families[] string    
page.enrollment.credentials.json.hostNames list    
page.enrollment.credentials.json.hostNames[] string    
page.enrollment.credentials.json.rules list    
page.enrollment.credentials.json.rules[].allowedProfiles list    
page.enrollment.credentials.json.rules[].allowedProfiles[] object   Nested deeper than this page draws.
page.enrollment.credentials.json.rules[].allowedProfilesSource string    
page.enrollment.credentials.json.rules[].certificateLifetimeDays number    
page.enrollment.credentials.json.rules[].certificateLifetimeSource string    
page.enrollment.credentials.json.rules[].defaultProfile string, or null    
page.enrollment.credentials.json.rules[].defaultProfileSource string    
page.enrollment.credentials.json.rules[].family string    
page.enrollment.credentials.json.rules[].label string    
page.enrollment.credentials.json.scepChallenges list    
page.enrollment.credentials.json.scepChallenges[].createdAt string, or number    
page.enrollment.credentials.json.scepChallenges[].createdBy string, or null    
page.enrollment.credentials.json.scepChallenges[].expiresAt string, or number    
page.enrollment.credentials.json.scepChallenges[].id string    
page.enrollment.credentials.json.scepChallenges[].profile string, or null    
page.enrollment.credentials.json.scepChallenges[].status string    
page.enrollment.credentials.json.scepChallenges[].usedAt string, or number, or null    
page.enrollment.credentials.keyAlgorithms list    
page.enrollment.credentials.keyAlgorithms[] string    
page.enrollment.credentials.paged object    
page.enrollment.credentials.paged.paging object    
page.enrollment.credentials.paged.paging.firstRow integer    
page.enrollment.credentials.paged.paging.lastRow integer    
page.enrollment.credentials.paged.paging.noun string    
page.enrollment.credentials.paged.paging.offset integer    
page.enrollment.credentials.paged.paging.page integer    
page.enrollment.credentials.paged.paging.pages integer    
page.enrollment.credentials.paged.paging.param string    
page.enrollment.credentials.paged.paging.perPage integer    
page.enrollment.credentials.paged.paging.total integer    
page.enrollment.credentials.paged.shown list    
page.enrollment.credentials.paged.shown[].attestation object, or string, or number, or boolean, or null   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].certificatePem string    
page.enrollment.credentials.paged.shown[].chainPem list    
page.enrollment.credentials.paged.shown[].chainPem[] object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].device string    
page.enrollment.credentials.paged.shown[].expired boolean    
page.enrollment.credentials.paged.shown[].family string    
page.enrollment.credentials.paged.shown[].issuedAt string    
page.enrollment.credentials.paged.shown[].keyAlg string    
page.enrollment.credentials.paged.shown[].keySource string    
page.enrollment.credentials.paged.shown[].names list    
page.enrollment.credentials.paged.shown[].names[] object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].notAfter string, or number    
page.enrollment.credentials.paged.shown[].notBefore string, or number    
page.enrollment.credentials.paged.shown[].profile string    
page.enrollment.credentials.paged.shown[].replaces string, or null    
page.enrollment.credentials.paged.shown[].requestedBy object    
page.enrollment.credentials.paged.shown[].requestedBy.admin object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].requestedBy.id object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].requestedBy.kind object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].revoked object    
page.enrollment.credentials.paged.shown[].revoked.at object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].revoked.by object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].revoked.reason object   Nested deeper than this page draws.
page.enrollment.credentials.paged.shown[].serialHex string    
page.enrollment.credentials.paged.shown[].status string    
page.enrollment.credentials.paged.shown[].subject string    
page.enrollment.credentials.paged.shown[].thumbprint string    
page.enrollment.credentials.paged.shown[].via string    
page.enrollment.credentials.rules list    
page.enrollment.credentials.rules[].allowedProfiles list    
page.enrollment.credentials.rules[].allowedProfiles[] string    
page.enrollment.credentials.rules[].allowedProfilesSource string    
page.enrollment.credentials.rules[].certificateLifetimeDays number    
page.enrollment.credentials.rules[].certificateLifetimeSource string    
page.enrollment.credentials.rules[].defaultProfile string, or null    
page.enrollment.credentials.rules[].defaultProfileSource string    
page.enrollment.credentials.rules[].family string    
page.enrollment.credentials.rules[].label string    
page.fga object    
page.fga.applicationPolicies object    
page.fga.applicationPolicies.count integer    
page.fga.applicationPolicies.max number    
page.fga.choices object    
page.fga.choices.categories list    
page.fga.choices.categories[] string    
page.fga.choices.dataTypes list    
page.fga.choices.dataTypes[] string    
page.fga.choices.multiplicities list    
page.fga.choices.multiplicities[] string    
page.fga.enforced boolean    
page.fga.failure string    
page.fga.known boolean    
page.fga.peps object    
page.fga.peps.authzenGroup string    
page.fga.peps.group string    
page.fga.peps.holders list    
page.fga.peps.holders[].dn string    
page.fga.peps.holders[].kind string    
page.fga.peps.holders[].member boolean    
page.fga.peps.holders[].name string    
page.fga.peps.holders[].scope boolean    
page.fga.peps.holders[].scoped boolean    
page.fga.peps.holders[].why string    
page.fga.peps.total integer    
page.fga.peps.truncated boolean    
page.fga.peps.unlocated integer    
page.fga.policy object    
page.fga.policy.application string, or null    
page.fga.policy.editor string    
page.fga.policy.enabled boolean    
page.fga.policy.name string    
page.fga.policy.orphanedAt string, or null    
page.fga.policy.own boolean    
page.fga.policy.policyId string, or null    
page.fga.policy.version string, or null    
page.fga.reference string, or null    
page.fga.template string    
page.fga.types list    
page.fga.types[].covered boolean    
page.fga.types[].notForPolicy list    
page.fga.types[].notForPolicy[] string    
page.fga.types[].rows integer    
page.fga.types[].type string    
page.fga.types[].uncovered list    
page.fga.types[].uncovered[] string    
page.fga.unreadable list    
page.fga.unreadable[].problem string    
page.fga.unreadable[].stored string    
page.fga.usable boolean    
page.fga.why string    
page.grantsUncataloguedAccess boolean    
page.krb5Across object    
page.krb5Across.choices object    
page.krb5Across.choices.krb5ForeignTgtDelegation list    
page.krb5Across.choices.krb5ForeignTgtDelegation[] string    
page.krb5Across.choices.krb5S4uSelfRealm list    
page.krb5Across.choices.krb5S4uSelfRealm[] string    
page.krb5Across.frontEnds list    
page.krb5Across.frontEnds[].actor string    
page.krb5Across.frontEnds[].ok boolean    
page.krb5Across.frontEnds[].path list    
page.krb5Across.frontEnds[].path[] string    
page.krb5Across.frontEnds[].problems list    
page.krb5Across.frontEnds[].problems[].kind string    
page.krb5Across.frontEnds[].problems[].params map   What the sentence names.
page.krb5Across.frontEnds[].problems[].params.{key} object   Nested deeper than this page draws.
page.krb5Across.frontEnds[].problems[].text string    
page.krb5Across.frontEnds[].realm string    
page.krb5Across.frontEnds[].via string    
page.krb5Across.realm string    
page.krb5Across.selfRealms list    
page.krb5Across.selfRealms[].accepted boolean    
page.krb5Across.selfRealms[].ok boolean    
page.krb5Across.selfRealms[].path list    
page.krb5Across.selfRealms[].path[] string    
page.krb5Across.selfRealms[].problems list    
page.krb5Across.selfRealms[].problems[].kind string    
page.krb5Across.selfRealms[].problems[].params map   What the sentence names.
page.krb5Across.selfRealms[].problems[].params.{key} object   Nested deeper than this page draws.
page.krb5Across.selfRealms[].problems[].text string    
page.krb5Across.selfRealms[].realm string    
page.krb5Across.selfRealms[].via string    
page.krb5Across.targets list    
page.krb5Across.targets[].classicProblems list    
page.krb5Across.targets[].classicProblems[].kind string    
page.krb5Across.targets[].classicProblems[].params map   What the sentence names.
page.krb5Across.targets[].classicProblems[].params.{key} object   Nested deeper than this page draws.
page.krb5Across.targets[].classicProblems[].text string    
page.krb5Across.targets[].classicRefused boolean    
page.krb5Across.targets[].ok boolean    
page.krb5Across.targets[].path list    
page.krb5Across.targets[].path[] string    
page.krb5Across.targets[].problems list    
page.krb5Across.targets[].problems[].kind string    
page.krb5Across.targets[].problems[].params map   What the sentence names.
page.krb5Across.targets[].problems[].params.{key} object   Nested deeper than this page draws.
page.krb5Across.targets[].problems[].text string    
page.krb5Across.targets[].realm string    
page.krb5Across.targets[].target string    
page.krb5Across.targets[].via string    
page.krb5Across.tgtDelegation object    
page.krb5Across.tgtDelegation.foreignTgtDelegation string    
page.krb5Across.tgtDelegation.trusts list    
page.krb5Across.tgtDelegation.trusts[].allowed boolean    
page.krb5Across.tgtDelegation.trusts[].attributes list    
page.krb5Across.tgtDelegation.trusts[].attributes[] string    
page.krb5Across.tgtDelegation.trusts[].delivered boolean    
page.krb5Across.tgtDelegation.trusts[].partner string    
page.krb5Across.tgtDelegation.unconstrained boolean    
page.launchUrls map   By protocol.
page.launchUrls.{key}.attribute string    
page.launchUrls.{key}.enabled boolean    
page.launchUrls.{key}.endpoint string, or null    
page.launchUrls.{key}.label string    
page.launchUrls.{key}.missing list    
page.launchUrls.{key}.missing[] string    
page.launchUrls.{key}.protocol string    
page.launchUrls.{key}.setting string    
page.launchUrls.{key}.url string    
page.lifetimes object    
page.lifetimes.rows list    
page.lifetimes.rows[].attribute string    
page.lifetimes.rows[].label string    
page.lifetimes.rows[].realmValue number    
page.lifetimes.rows[].setting string    
page.lifetimes.rows[].source string    
page.lifetimes.rows[].value number    
page.lifetimes.skew number    
page.maxOwners number    
page.notes map   What each attribute of the entry is.
page.notes.{key}.sensitive boolean    
page.notes.{key}.text string    
page.observed object    
page.observed.paging object    
page.observed.paging.firstRow integer    
page.observed.paging.lastRow integer    
page.observed.paging.noun string    
page.observed.paging.offset integer    
page.observed.paging.page integer    
page.observed.paging.pages integer    
page.observed.paging.param string    
page.observed.paging.perPage integer    
page.observed.paging.total integer    
page.observed.shown list    
page.observed.shown[].attribute string    
page.observed.shown[].held boolean    
page.observed.shown[].trusted boolean    
page.observed.shown[].value string    
page.owners list    
page.owners[].dn string    
page.owners[].kind string    
page.owners[].name string    
page.owners[].present boolean    
page.ownership object    
page.ownership.kind string    
page.ownership.marked boolean    
page.ownership.name string    
page.ownership.protected boolean    
page.ownership.reasons list    
page.ownership.reasons[] string    
page.passkeyPolicies object    
page.passkeyPolicies.applies string    
page.passkeyPolicies.groupPolicies integer    
page.passkeyPolicies.link string    
page.passkeyPolicies.missing boolean    
page.passkeyPolicies.named string    
page.passkeyPolicies.precedence number    
page.permissionClaims object    
page.permissionClaims.catalogue list    
page.permissionClaims.catalogue[].claim string    
page.permissionClaims.catalogue[].label string    
page.permissionClaims.catalogue[].ldap string    
page.permissionClaims.permissions list    
page.permissionClaims.permissions[].attributes list    
page.permissionClaims.permissions[].attributes[] string    
page.permissionClaims.permissions[].description string, or null    
page.permissionClaims.permissions[].id string, or null    
page.permissionClaims.permissions[].name string    
page.permissionClaims.stale list    
page.permissionClaims.stale[] string    
page.permissions object    
page.permissions.clients list    
page.permissions.clients[].identifier string    
page.permissions.clients[].name string    
page.permissions.exposedPage object    
page.permissions.exposedPage.paging object    
page.permissions.exposedPage.paging.firstRow integer    
page.permissions.exposedPage.paging.lastRow integer    
page.permissions.exposedPage.paging.noun string    
page.permissions.exposedPage.paging.offset integer    
page.permissions.exposedPage.paging.page integer    
page.permissions.exposedPage.paging.pages integer    
page.permissions.exposedPage.paging.param string    
page.permissions.exposedPage.paging.perPage integer    
page.permissions.exposedPage.paging.total integer    
page.permissions.exposedPage.shown list    
page.permissions.exposedPage.shown[].baseUri string, or null    
page.permissions.exposedPage.shown[].description string, or null    
page.permissions.exposedPage.shown[].grantedTo list    
page.permissions.exposedPage.shown[].grantedTo[].asked object   Nested deeper than this page draws.
page.permissions.exposedPage.shown[].grantedTo[].identifier object   Nested deeper than this page draws.
page.permissions.exposedPage.shown[].grantedTo[].name object   Nested deeper than this page draws.
page.permissions.exposedPage.shown[].id string, or null    
page.permissions.exposedPage.shown[].name string    
page.permissions.exposedPage.shown[].raw string, or null    
page.permissions.exposedPage.shown[].resource string    
page.permissions.exposedPage.shown[].resourceName string    
page.permissions.exposes list    
page.permissions.exposes[].baseUri string, or null    
page.permissions.exposes[].description string, or null    
page.permissions.exposes[].grantedTo list    
page.permissions.exposes[].grantedTo[].asked boolean    
page.permissions.exposes[].grantedTo[].identifier string    
page.permissions.exposes[].grantedTo[].name string    
page.permissions.exposes[].id string, or null    
page.permissions.exposes[].name string    
page.permissions.exposes[].raw string, or null    
page.permissions.exposes[].resource string    
page.permissions.exposes[].resourceName string    
page.permissions.grantedOutPage object    
page.permissions.grantedOutPage.paging object    
page.permissions.grantedOutPage.paging.firstRow integer    
page.permissions.grantedOutPage.paging.lastRow integer    
page.permissions.grantedOutPage.paging.noun string    
page.permissions.grantedOutPage.paging.offset integer    
page.permissions.grantedOutPage.paging.page integer    
page.permissions.grantedOutPage.paging.pages integer    
page.permissions.grantedOutPage.paging.param string    
page.permissions.grantedOutPage.paging.perPage integer    
page.permissions.grantedOutPage.paging.total integer    
page.permissions.grantedOutPage.shown list    
page.permissions.grantedOutPage.shown[].asked boolean    
page.permissions.grantedOutPage.shown[].baseUri string, or null    
page.permissions.grantedOutPage.shown[].client string    
page.permissions.grantedOutPage.shown[].clientName string    
page.permissions.grantedOutPage.shown[].dangling boolean    
page.permissions.grantedOutPage.shown[].description string, or null    
page.permissions.grantedOutPage.shown[].permissionId string    
page.permissions.grantedOutPage.shown[].permissionName string    
page.permissions.grantedOutPage.shown[].resource string    
page.permissions.grantedOutPage.shown[].resourceName string    
page.permissions.held list    
page.permissions.held[].asked boolean    
page.permissions.held[].baseUri string, or null    
page.permissions.held[].client string    
page.permissions.held[].clientName string    
page.permissions.held[].dangling boolean    
page.permissions.held[].description string, or null    
page.permissions.held[].permissionId string    
page.permissions.held[].permissionName string    
page.permissions.held[].resource string    
page.permissions.held[].resourceName string    
page.permissions.heldPage object    
page.permissions.heldPage.paging object    
page.permissions.heldPage.paging.firstRow integer    
page.permissions.heldPage.paging.lastRow integer    
page.permissions.heldPage.paging.noun string    
page.permissions.heldPage.paging.offset integer    
page.permissions.heldPage.paging.page integer    
page.permissions.heldPage.paging.pages integer    
page.permissions.heldPage.paging.param string    
page.permissions.heldPage.paging.perPage integer    
page.permissions.heldPage.paging.total integer    
page.permissions.heldPage.shown list    
page.permissions.heldPage.shown[].asked boolean    
page.permissions.heldPage.shown[].baseUri string, or null    
page.permissions.heldPage.shown[].client string    
page.permissions.heldPage.shown[].clientName string    
page.permissions.heldPage.shown[].dangling boolean    
page.permissions.heldPage.shown[].description string, or null    
page.permissions.heldPage.shown[].permissionId string    
page.permissions.heldPage.shown[].permissionName string    
page.permissions.heldPage.shown[].resource string    
page.permissions.heldPage.shown[].resourceName string    
page.permissions.offerable list    
page.permissions.offerable[].baseUri string, or null    
page.permissions.offerable[].description string, or null    
page.permissions.offerable[].grantedTo list    
page.permissions.offerable[].grantedTo[].asked boolean    
page.permissions.offerable[].grantedTo[].identifier string    
page.permissions.offerable[].grantedTo[].name string    
page.permissions.offerable[].id string, or null    
page.permissions.offerable[].name string    
page.permissions.offerable[].raw string, or null    
page.permissions.offerable[].resource string    
page.permissions.offerable[].resourceName string    
page.permissions.registerPermissions integer    
page.protocolRows list    
page.protocolRows[].id string    
page.protocolRows[].kind string    
page.protocolRows[].kinds list    
page.protocolRows[].kinds[] string    
page.protocolRows[].label string    
page.roles object    
page.roles.held list    
page.roles.held[].application string    
page.roles.held[].carriedAs string    
page.roles.held[].displayName string    
page.roles.held[].id string    
page.roles.held[].name string    
page.roles.held[].permissions list    
page.roles.held[].permissions[] string    
page.roles.offerable list    
page.roles.offerable[] string    
page.roles.requirable list    
page.roles.requirable[] string    
page.roles.required list    
page.roles.required[].displayName string    
page.roles.required[].name string    
page.roles.required[].resolves string    
page.roles.required[].role string    
page.signals object    
page.signals.installed boolean    
page.signals.json object    
page.signals.json.installed boolean    
page.signals.json.settings list    
page.signals.json.settings[].attribute string    
page.signals.json.settings[].setting string    
page.signals.json.settings[].source string    
page.signals.json.settings[].value list, or string, or number, or boolean, or null    
page.signals.json.settings[].value[] object   Nested deeper than this page draws.
page.signals.json.streams list    
page.signals.json.streams[].aud list, or string, or number, or boolean, or null    
page.signals.json.streams[].aud[] object   Nested deeper than this page draws.
page.signals.json.streams[].createdAt string, or number    
page.signals.json.streams[].createdBy string    
page.signals.json.streams[].delivery object    
page.signals.json.streams[].delivery.endpoint_url string, or null    
page.signals.json.streams[].delivery.method string    
page.signals.json.streams[].description string    
page.signals.json.streams[].events_delivered list    
page.signals.json.streams[].events_delivered[] string    
page.signals.json.streams[].events_requested list    
page.signals.json.streams[].events_requested[] string    
page.signals.json.streams[].format string    
page.signals.json.streams[].lastPushAt string, or number    
page.signals.json.streams[].lastPushError string    
page.signals.json.streams[].status string    
page.signals.json.streams[].statusReason string, or null    
page.signals.json.streams[].stream_id string    
page.signals.json.streams[].updatedAt string, or number    
page.signals.settings list    
page.signals.settings[].attribute string    
page.signals.settings[].setting string    
page.signals.settings[].source string    
page.signals.settings[].value list, or string, or number, or boolean, or null    
page.signals.settings[].value[] string    
page.signals.streams list    
page.signals.streams[].aud list, or string, or number, or boolean, or null    
page.signals.streams[].aud[] string, or number, or boolean    
page.signals.streams[].createdAt string, or number    
page.signals.streams[].createdBy string    
page.signals.streams[].delivery object    
page.signals.streams[].delivery.endpoint_url string, or null    
page.signals.streams[].delivery.method string    
page.signals.streams[].description string    
page.signals.streams[].events_delivered list    
page.signals.streams[].events_delivered[] string    
page.signals.streams[].events_requested list    
page.signals.streams[].events_requested[] string    
page.signals.streams[].format string    
page.signals.streams[].lastPushAt string, or number    
page.signals.streams[].lastPushError string    
page.signals.streams[].status string    
page.signals.streams[].statusReason string, or null    
page.signals.streams[].stream_id string    
page.signals.streams[].updatedAt string, or number    
page.softwareStatement object    
page.softwareStatement.issued object    
page.softwareStatement.issued.expiresAt number    
page.softwareStatement.issued.issuedAt number    
page.softwareStatement.issued.issuer string    
page.softwareStatement.issued.metadata any JSON   RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines. RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines.
page.softwareStatement.issued.readable boolean    
page.softwareStatement.issued.thumbprint string    
page.softwareStatement.issued.typed boolean    
page.softwareStatement.issued.verifies boolean    
page.softwareStatement.issued.why string    
page.softwareStatement.issuedToken string    
page.softwareStatement.issuers list    
page.softwareStatement.issuers[] string    
page.softwareStatement.json object    
page.softwareStatement.json.declaredIssuers list    
page.softwareStatement.json.declaredIssuers[] string    
page.softwareStatement.json.issued object    
page.softwareStatement.json.issued.expiresAt number    
page.softwareStatement.json.issued.issuedAt number    
page.softwareStatement.json.issued.issuer string    
page.softwareStatement.json.issued.metadata any JSON   RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines. RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines.
page.softwareStatement.json.issued.readable boolean    
page.softwareStatement.json.issued.statement string    
page.softwareStatement.json.issued.thumbprint string    
page.softwareStatement.json.issued.typed boolean    
page.softwareStatement.json.issued.verifies boolean    
page.softwareStatement.json.issued.why string    
page.softwareStatement.json.registeredWith object    
page.softwareStatement.json.registeredWith.issuer string    
page.softwareStatement.json.registeredWith.publisher string    
page.softwareStatement.json.registeredWith.trusted boolean    
page.softwareStatement.json.settings object    
page.softwareStatement.json.settings.lifetimeSeconds number    
page.softwareStatement.json.settings.opensRegistration boolean    
page.softwareStatement.json.settings.requireTrustedIssuer boolean    
page.softwareStatement.json.settings.required boolean    
page.softwareStatement.json.usableKeys integer    
page.softwareStatement.keyProblems list    
page.softwareStatement.keyProblems[] list, or string, or number, or boolean, or null    
page.softwareStatement.keyProblems[][] string, or number, or boolean    
page.softwareStatement.registeredWith object    
page.softwareStatement.registeredWith.issuer string    
page.softwareStatement.registeredWith.publisher string    
page.softwareStatement.registeredWith.trusted boolean    
page.softwareStatement.settings object    
page.softwareStatement.settings.lifetimeSeconds number    
page.softwareStatement.settings.opensRegistration boolean    
page.softwareStatement.settings.requireTrustedIssuer boolean    
page.softwareStatement.settings.required boolean    
page.softwareStatement.usableKeys integer    
page.warnings list    
page.warnings[].attribute string    
page.warnings[].dropped boolean    
page.warnings[].reason string    
page.warnings[].text string    
page.warnings[].value string    
pages integer    
paging object    
paging.firstRow integer    
paging.lastRow integer    
paging.noun string    
paging.page integer    
paging.pages integer    
paging.param string    
paging.perPage integer    
paging.total integer    
perPage integer    
protocols list    
protocols[] object, or string    
protocols[].deliveryAttribute string    
protocols[].eventsAttribute string    
protocols[].id string    
protocols[].identifierAttribute string    
protocols[].kind string    
protocols[].kinds list    
protocols[].kinds[] string    
protocols[].label string    
protocols[].logoutAttribute string    
protocols[].redirectAttribute string    
protocols[].secretAttribute string    
protocols[].what string    
recordedProtocols list    
recordedProtocols[] string    
registered boolean, or number    
registeredBy string    
returnAddressesObserved list    
returnAddressesObserved[].attribute string    
returnAddressesObserved[].held boolean    
returnAddressesObserved[].trusted boolean    
returnAddressesObserved[].value string    
returnAddressesObservedPaging object    
returnAddressesObservedPaging.firstRow integer    
returnAddressesObservedPaging.lastRow integer    
returnAddressesObservedPaging.noun string    
returnAddressesObservedPaging.page integer    
returnAddressesObservedPaging.pages integer    
returnAddressesObservedPaging.param string    
returnAddressesObservedPaging.perPage integer    
returnAddressesObservedPaging.total integer    
returnAddressesObservedShown list    
returnAddressesObservedShown[].attribute string    
returnAddressesObservedShown[].held boolean    
returnAddressesObservedShown[].trusted boolean    
returnAddressesObservedShown[].value string    
sessions number    
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   The sentence beside each of a list’s values.
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string    
settings.groups[].settings[].default list, or string, or number, or boolean, 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 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    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or string, or number, or boolean, 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 each settings group is drawn on.
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
sharedSignals object    
sharedSignals.installed boolean    
sharedSignals.settings list    
sharedSignals.settings[].attribute string    
sharedSignals.settings[].setting string    
sharedSignals.settings[].source string    
sharedSignals.settings[].value list, or string, or number, or boolean, or null    
sharedSignals.settings[].value[] string    
sharedSignals.streams list    
sharedSignals.streams[].aud list, or string, or number, or boolean, or null    
sharedSignals.streams[].aud[] string, or number, or boolean    
sharedSignals.streams[].createdAt string, or number    
sharedSignals.streams[].createdBy string    
sharedSignals.streams[].delivery object    
sharedSignals.streams[].delivery.endpoint_url string, or null    
sharedSignals.streams[].delivery.method string    
sharedSignals.streams[].description string    
sharedSignals.streams[].events_delivered list    
sharedSignals.streams[].events_delivered[] string    
sharedSignals.streams[].events_requested list    
sharedSignals.streams[].events_requested[] string    
sharedSignals.streams[].format string    
sharedSignals.streams[].lastPushAt string, or number    
sharedSignals.streams[].lastPushError string    
sharedSignals.streams[].status string    
sharedSignals.streams[].statusReason string, or null    
sharedSignals.streams[].stream_id string    
sharedSignals.streams[].updatedAt string, or number    
shown integer    
softwareStatements object    
softwareStatements.declaredIssuers list    
softwareStatements.declaredIssuers[] string    
softwareStatements.issued object    
softwareStatements.issued.expiresAt number    
softwareStatements.issued.issuedAt number    
softwareStatements.issued.issuer string    
softwareStatements.issued.metadata any JSON   RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines. RFC 7591 client metadata fixed by a software statement: any member a publisher chose, including extensions no specification defines.
softwareStatements.issued.readable boolean    
softwareStatements.issued.statement string    
softwareStatements.issued.thumbprint string    
softwareStatements.issued.typed boolean    
softwareStatements.issued.verifies boolean    
softwareStatements.issued.why string    
softwareStatements.registeredWith object    
softwareStatements.registeredWith.issuer string    
softwareStatements.registeredWith.publisher string    
softwareStatements.registeredWith.trusted boolean    
softwareStatements.settings object    
softwareStatements.settings.lifetimeSeconds number    
softwareStatements.settings.opensRegistration boolean    
softwareStatements.settings.requireTrustedIssuer boolean    
softwareStatements.settings.required boolean    
softwareStatements.usableKeys integer    
tokenLifetimes object    
tokenLifetimes.clockSkewS number    
tokenLifetimes.lifetimes list    
tokenLifetimes.lifetimes[].attribute string    
tokenLifetimes.lifetimes[].label string    
tokenLifetimes.lifetimes[].realmValue number    
tokenLifetimes.lifetimes[].setting string    
tokenLifetimes.lifetimes[].source string    
tokenLifetimes.lifetimes[].value number    
users number    
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

400: The answer.

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

POST /admin-api/applications/add

addApplicationValue

Add a value to a multi-valued attribute

For the attributes that hold a LIST — appCorsOrigin, appAllowedProtocol, oauthClientId, oauthAudience, oauthRedirectUri, oauthClaimsRedirectUri, oauthPostLogoutRedirectUri, oauthGrantType, oauthResponseType, oauthAllowedTokenResponseTypes, oauthScope, oauthAllowedScope, oauthPermission, oauthRoleGatedPermission, oauthDelegatedPermission, oauthGlobalConsent, oauthTokenEndpointAuthMethod, oauthRequestUri, oauthAuthorizationDetailsType, oauthAuthorizationDetailsTypes, authzenAttribute, appAuthzenApplication, appAuthzenCallbackUri, oauthAssertionIssuer, oauthSamlAssertionIssuer, oauthSoftwareStatementIssuer, samlEntityId, samlAssertionConsumerService, samlSingleLogoutService, samlSigningCertificate, oauthAccessTokenClaim, appRequiredRole, appAllowedToDelegateTo, appAllowedToActOnBehalfOf, appDelegationSubjectGroup, appDelegationSemantics, wsfedRealm, wsfedReplyUrl, wsfedSignOutUri, wstrustAppliesTo, wstrustJwtScope, krb5ServicePrincipalName, krb5S4uSelfRealm, oid4vpClientId, federationPartnerId, ldapBindDn, scimClientId, acmeAllowedProfiles, estAllowedProfiles, scepAllowedProfiles, didPublicKeyJwk, didService, didAlsoKnownAs, scimClientScopeGroups, scimClientGroups, scimClientCells, ssfReceiverId, ssfDeliveryEndpoint, ssfAllowedEvents, gnapFinishUri, gnapInteractionStartModes, gnapAllowedAccess, gnapResourceServerUri, spiffeWorkloadId, appFederationRelationship.

This is the one that matters most: a value added to oauthRedirectUri is a redirect URI RFC 9700 mode accepts by exact string match on the next authorization request. Note that it is the REGISTERED list — appRedirectUriObserved, which records what a client actually used, is not editable, because “registered” and “used” are different facts and section 2.1 is entirely about not confusing them.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attribute one of appCorsOrigin, appAllowedProtocol, oauthClientId, oauthAudience, oauthRedirectUri, oauthClaimsRedirectUri, oauthPostLogoutRedirectUri, oauthGrantType, oauthResponseType, oauthAllowedTokenResponseTypes, oauthScope, oauthAllowedScope, oauthPermission, oauthRoleGatedPermission, oauthDelegatedPermission, oauthGlobalConsent, oauthTokenEndpointAuthMethod, oauthRequestUri, oauthAuthorizationDetailsType, oauthAuthorizationDetailsTypes, authzenAttribute, appAuthzenApplication, appAuthzenCallbackUri, oauthAssertionIssuer, oauthSamlAssertionIssuer, oauthSoftwareStatementIssuer, samlEntityId, samlAssertionConsumerService, samlSingleLogoutService, samlSigningCertificate, oauthAccessTokenClaim, appRequiredRole, appAllowedToDelegateTo, appAllowedToActOnBehalfOf, appDelegationSubjectGroup, appDelegationSemantics, wsfedRealm, wsfedReplyUrl, wsfedSignOutUri, wstrustAppliesTo, wstrustJwtScope, krb5ServicePrincipalName, krb5S4uSelfRealm, oid4vpClientId, federationPartnerId, ldapBindDn, scimClientId, acmeAllowedProfiles, estAllowedProfiles, scepAllowedProfiles, didPublicKeyJwk, didService, didAlsoKnownAs, scimClientScopeGroups, scimClientGroups, scimClientCells, ssfReceiverId, ssfDeliveryEndpoint, ssfAllowedEvents, gnapFinishUri, gnapInteractionStartModes, gnapAllowedAccess, gnapResourceServerUri, spiffeWorkloadId, appFederationRelationship yes  
value string yes  

200: The application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

POST /admin-api/applications/add-certificate

addApplicationCertificate

Store a certificate on an application’s entry, so an outside certificate authority’s certificate authenticates it

Stores one X.509 certificate in the application’s userCertificate (RFC 4523; written as userCertificate;binary). A certificate from an outside certificate authority — one trusted through the Client Truststores — is an identity at a door that reads a client certificate as an application (a Shared Signals receiver’s, for one) only while it is stored, byte for byte, on exactly one entry of the realm: never by its common name or subject (#1061, #1227). Refused when it is not one certificate (STS-ADMIN-0897), when it is already stored on another entry (STS-ADMIN-0899) or the registry holds no such application (STS-ADMIN-0906). A renewed certificate is stored again. Sends a CAEP credential-change (x509) under the application’s own subject. RFC 8705’s token endpoint does not read it: tls_client_auth keeps its own registered subject.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes The application’s identifier, exactly as this registry holds it.
certificate string yes The leaf, as one PEM block or base64 DER.

200: The certificates the entry stores now.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificates list    
certificates[].expired boolean    
certificates[].issuer string    
certificates[].notAfter string    
certificates[].notBefore string    
certificates[].readable boolean    
certificates[].serialNumber string    
certificates[].sha256 string    
certificates[].subject string    
changed list, or boolean    
changed[] string    
dn string, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
rule string    
sha256 string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificates list    
certificates[].expired boolean    
certificates[].issuer string    
certificates[].notAfter string    
certificates[].notBefore string    
certificates[].readable boolean    
certificates[].serialNumber string    
certificates[].sha256 string    
certificates[].subject string    
changed list, or boolean    
changed[] string    
dn string, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
rule string    
sha256 string    

POST /admin-api/applications/add-owner

addApplicationOwner

Add one owner to an application

Adds a person or a group of this realm to the application’s appOwner values and writes at once. owner is a username, a DN or a urn:uuid: subject for a person, a cn or DN for a group. One that names nobody is refused; at most 25. An owner already listed is ok with changed: false.

AN OWNER GRANTS NOTHING; the user portal lists what a person owns.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
owner string yes The person or group to add.

200: The application’s owners as they now stand (owners).

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
owners list    
owners[].dn string    
owners[].kind string    
owners[].name string    
owners[].present boolean    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
owners list    
owners[].dn string    
owners[].kind string    
owners[].name string    
owners[].present boolean    

POST /admin-api/applications/add-secret

addApplicationClientSecret

Add a client secret beside the ones an application holds

Mints a secret as regenerate-secret does and ADDS it: every secret already held goes on authenticating until its own expiry. The new one is the newest, so it becomes the PRIMARY — the one this service signs HS256 ID Tokens and JARM with, keys symmetric encryption with, and returns as RFC 7591’s client_secret. lifetimeDays is its lifetime in whole days, 0 to 730 (0 never expires; omitted or empty, oauth2.clientSecretLifetimeDays), and description one line saying what it is for. Refused past oauth2.clientSecretsMax.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
description string    
lifetimeDays integer or string    

200: The new secret in clientSecret, its secretId and expiresAt (seconds, 0 never), and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

POST /admin-api/applications/clear-permission-claims

clearApplicationPermissionClaims

Take the claims off one of a resource server’s own scopes

Removes the mapping of one permission, so granting it adds no claim to an access token.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
permission string yes  

200: The whole map left, in mappings.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
mappings map   Each permission’s claims.
mappings.{key} list    
mappings.{key}[] string    
message string    
ok boolean yes  
permission string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
mappings map   Each permission’s claims.
mappings.{key} list    
mappings.{key}[] string    
message string    
ok boolean yes  
permission string    

POST /admin-api/applications/confirm-address

confirmApplicationReturnAddress

Confirm a return address a development-mode request recorded

A return address — a SAML ACS URL or shire on samlAssertionConsumerService, a WS-Federation wreply on wsfedReplyUrl, or a callback this service learnt for its own console or portal on oauthRedirectUri — that a request NAMED while the realm was in DEVELOPMENT mode is written onto the entry and MARKED on appReturnAddressObserved (<attribute> <address>). PRODUCT mode refuses a marked address exactly as it refuses one that is not on the entry, so a realm switched from development to product does not trust what development learnt.

This takes the mark OFF and keeps the address, so product believes it from the next request. An address that is not marked is REFUSED by name rather than confirmed silently — it is already registered, or it is not on the entry. add of the same address confirms it too, because an explicit write is a registration.

GET /admin-api/applications?application=… lists the marked addresses as returnAddressesObserved, each with trusted saying whether THIS realm’s mode believes it. Addresses recorded before this service marked sightings carry no mark and cannot be told apart from registered ones.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes The identifier, exactly as the registry holds it.
attribute one of oauthRedirectUri, samlAssertionConsumerService, wsfedReplyUrl, gnapFinishUri yes The return-address attribute the address is on.
value string yes The address, exactly as the entry holds it.

200: The application as it now stands, with the mark gone from returnAddressesObserved.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/create

createApplication

Put an application in the registry before it connects

An entry usually appears because an identifier was ACCEPTED — a client_id at the token endpoint, a wtrealm on a sign-in response, an SPN on a TGS-REP. This is how to get one in ahead of that, which is what RFC 9700 mode needs if a client is to be judged against its OWN redirect URIs rather than against the oauth2.redirectUris setting.

It is created with zero counters and a description saying it was created by hand, so it cannot be mistaken for an application that turned up once and never came back. Give it its redirect URIs and grant types with add afterwards.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
fields object   THE ATTRIBUTES THE ENTRY IS CREATED WITH, keyed by the schema’s own attribute name and valued with a string or an array of strings. This is where the per-protocol identifiers and the redirect URIs go — oauthClientId, samlEntityId, wsfedRealm, krb5ServicePrincipalName, oauthRedirectUri, samlAssertionConsumerService, wsfedReplyUrl and the rest. GET /admin-api/applications/new publishes the list as declarations, with the families each attribute serves and whether it holds a list; it is the same walk of the protocol table the console’s form is drawn from, so this document and that page cannot offer different fields. GET /admin/ldap/applications publishes every attribute in the schema with an editable member. Only DECLARED attributes may be given. A derived one — a counter, a sighting, appProtocol, appRedirectUriObserved — is REFUSED by name rather than written, because an entry created with one would be asserting a past it does not have. A single-valued attribute given several values is refused as well, rather than truncated to the first: the only one you are likely to meet is oauthTlsClientAuthSubjectDn, which an RFC 8705 check compares by exact string equality, and quietly keeping one of two is exactly the wrong answer there. Nothing given here is CHECKED except the OAuth redirect URIs, and those only in RFC 9700 mode. The rest are recorded, in the way being in this registry at all is a record. 106 attributes are scoped to a PROTOCOL FAMILY and REFUSED on an application declared for none of them: oauthNativeSso (OpenID Connect), oauthNativeSsoGroup (OpenID Connect), oauthBackchannelTokenDeliveryMode (OpenID Connect), oauthBackchannelClientNotificationEndpoint (OpenID Connect), oauthCommandEndpoint (OpenID Connect), oauthBackchannelAuthenticationRequestSigningAlg (OpenID Connect), oauthBackchannelUserCodeParameter (OpenID Connect), oauthSubjectType (OpenID Connect), oauthSectorIdentifierUri (OpenID Connect), oauthDidClaimWithPairwise (OpenID Connect), oauthTokenEndpointAuthSigningAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionSignedResponseAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionEncryptedResponseAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionEncryptedResponseEnc (OAuth 2.0, OpenID Connect), oauthRequestUri (OAuth 2.0, OpenID Connect), oauthRequestObjectSigningAlg (OAuth 2.0, OpenID Connect), oauthRequestObjectEncryptionAlg (OAuth 2.0, OpenID Connect), oauthRequestObjectEncryptionEnc (OAuth 2.0, OpenID Connect), oauthRequireSignedRequestObject (OAuth 2.0, OpenID Connect), oauthRequirePushedAuthorizationRequests (OAuth 2.0, OpenID Connect), oauthHttpSignedRequests (OAuth 2.0, OpenID Connect), oauthAuthorizationDetailsType (OAuth 2.0, OpenID Connect, GNAP), oauthAuthorizationDetailsTypes (OAuth 2.0, OpenID Connect), authzenAttribute (OAuth 2.0, OpenID Connect), appAuthzenApplication (OAuth 2.0, OpenID Connect), appAuthzenCallbackUri (OAuth 2.0, OpenID Connect), oauthStepUpAcrValues (OAuth 2.0, OpenID Connect), oauthStepUpMaxAge (OAuth 2.0, OpenID Connect), oauthIdTokenSignedResponseAlg (OpenID Connect), oauthIdTokenEncryptedResponseAlg (OpenID Connect), oauthIdTokenEncryptedResponseEnc (OpenID Connect), oauthUserinfoSignedResponseAlg (OpenID Connect), oauthUserinfoEncryptedResponseAlg (OpenID Connect), oauthUserinfoEncryptedResponseEnc (OpenID Connect), oauthAuthorizationSignedResponseAlg (OAuth 2.0, OpenID Connect), oauthAuthorizationEncryptedResponseAlg (OAuth 2.0, OpenID Connect), oauthAuthorizationEncryptedResponseEnc (OAuth 2.0, OpenID Connect), oauthDefaultAcrValues (OpenID Connect), oauthDefaultMaxAge (OpenID Connect), oauthThirdPartyInitiatedLogin (OAuth 2.0, OpenID Connect), oauthSpInitiatedSso (OAuth 2.0, OpenID Connect), oauthInitiateLoginUri (OAuth 2.0, OpenID Connect), oauthLogoUri (OAuth 2.0, OpenID Connect), oauthPolicyUri (OAuth 2.0, OpenID Connect), oauthTosUri (OAuth 2.0, OpenID Connect), oauthTokenExchangeRefreshToken (OAuth 2.0, OpenID Connect), vcCredentialClaimAttributes (OpenID4VCI), wstrustJwtScope (WS-Trust), krb5S4uSelfRealm (Kerberos v5), krb5ForeignTgtDelegation (Kerberos v5), secretDestProvider (Secret push destination), secretDestPayload (Secret push destination), secretDestRegion (Secret push destination), secretDestProject (Secret push destination), secretDestEndpoint (Secret push destination), secretDestMount (Secret push destination), secretDestField (Secret push destination), secretDestDirectory (Secret push destination), secretDestCaCertificates (Secret push destination), secretDestCredential (Secret push destination), scimClientBaseUrl (SCIM client (outbound provisioning)), scimClientEnabled (SCIM client (outbound provisioning)), scimClientAuthMethod (SCIM client (outbound provisioning)), scimClientUsername (SCIM client (outbound provisioning)), scimClientPassword (SCIM client (outbound provisioning)), scimClientTokenEndpoint (SCIM client (outbound provisioning)), scimClientOAuthClientId (SCIM client (outbound provisioning)), scimClientOAuthClientSecret (SCIM client (outbound provisioning)), scimClientOAuthClientAuth (SCIM client (outbound provisioning)), scimClientOAuthScope (SCIM client (outbound provisioning)), scimClientOAuthResource (SCIM client (outbound provisioning)), scimClientTlsSource (SCIM client (outbound provisioning)), scimClientTlsCertificate (SCIM client (outbound provisioning)), scimClientTlsPrivateKey (SCIM client (outbound provisioning)), scimClientCaCertificates (SCIM client (outbound provisioning)), scimClientScopeMode (SCIM client (outbound provisioning)), scimClientScopeGroups (SCIM client (outbound provisioning)), scimClientScopeFilter (SCIM client (outbound provisioning)), scimClientGroupMode (SCIM client (outbound provisioning)), scimClientGroups (SCIM client (outbound provisioning)), scimClientDeprovision (SCIM client (outbound provisioning)), scimClientReconcileMinutes (SCIM client (outbound provisioning)), scimClientJurisdiction (SCIM client (outbound provisioning)), scimClientCells (SCIM client (outbound provisioning)), scimClientMaxRequestsPerSecond (SCIM client (outbound provisioning)), ssfAllowedEvents (Shared Signals), ssfCaepIncludeReasons (Shared Signals), ssfCaepReasonLanguage (Shared Signals), ssfCaepOmitEventTimestamp (Shared Signals), ssfRiscIncludeReasons (Shared Signals), ssfRiscReasonLanguage (Shared Signals), ssfRiscOmitEventTimestamp (Shared Signals), ssfSigningAlgorithm (Shared Signals), ssfMinVerificationInterval (Shared Signals), ssfInactivityTimeoutS (Shared Signals), ssfInactivityAction (Shared Signals), ssfVerificationEveryS (Shared Signals), ssfStreamStatusOnCreate (Shared Signals), ssfMaxStreams (Shared Signals), ssfMaxSubjectsPerStream (Shared Signals), ssfMaxQueuedEvents (Shared Signals), ssfPollMaxEvents (Shared Signals), ssfDeadLetterMaxPerStream (Shared Signals), ssfPushTimeoutMs (Shared Signals), ssfPushRetries (Shared Signals), ssfPushRetryDelayMs (Shared Signals). That is unlike every other attribute here, which is inert rather than wrong on an entry that never reaches the protocol it belongs to — these decide what an ENDPOINT does for an identifier, so on an entry no request could ever name they would read as a policy that was in force. Declare the family first (protocols on the create, or add to appAllowedProtocol). Clearing one is never refused, and ldapmodify reaches them like every other attribute.
identifier string yes The client_id, wtrealm, AppliesTo, entityID or service principal name. One application per identifier whatever protocol brings it, so this is refused if one is already here.
kind one of oauth2-client, oauth2-resource-server, oidc-relying-party, saml2-service-provider, saml11-relying-party, wsfed-relying-party, wstrust-relying-party, oid4vp-verifier, federation-identity-provider, kerberos-service, gnap-client, gnap-resource-server   Optional, one of the kinds GET /admin-api/applications/new lists. It is a claim about what this application IS, which is why a value the registry does not know is refused rather than recorded. No console form offers this any more and it is still taken here. It was a select on /admin/applications/new beside the protocol families, which is two vocabularies for one question — eight kinds against fourteen families, five of them with no kind at all — and it is DERIVED rather than declared: a kind is written when a protocol actually recognises the identifier, so a form choosing one asserted a sighting that had not happened. Prefer protocols.
lifetimeDays integer or string   The lifetime of the client secret the create carries in fields.oauthClientSecret (#394), as add-secret takes it: whole days, 0 to 730, 0 never expiring; omitted or empty, oauth2.clientSecretLifetimeDays (defaultSecretLifetimeDays in GET /admin-api/applications/new). It is stamped on the secret’s record as its expires. A lifetime outside that range is refused, and so is one given with no secret, or with a whole secret record, which keeps the expiry it carries.
name string   Optional friendly name.
protocols list   THE PROTOCOL FAMILIES THIS APPLICATION IS DECLARED FOR, as ids from the closed vocabulary GET /admin-api/applications/new publishes. They land on appAllowedProtocol, and one that is not in that list is REFUSED rather than recorded — a typo that silently became a new family is how one application comes to be declared for two spellings of one thing. IT GRANTS AND REFUSES NOTHING. Nothing in this service reads the attribute: an application declared for saml2 alone is still issued an access token at /oauth2/token, and one declared for nothing is treated exactly as it would have been. It is a record of INTENT, kept apart from appProtocol — which is what has actually happened and is not editable — so the two lists on an entry can be read against each other. A form-encoded body may repeat protocol instead, which is how the console’s checkbox column posts it, and a single string may carry several separated by spaces or commas. A COMBINED CHOICE the console draws as one checkbox stands for its families: vc declares oid4vci and oid4vp.
protocols[] one of oauth2, oidc, saml2, saml11, wsfed, wstrust, krb5, oid4vci, oid4vp, federation, ldap, scim, spiffe, mtls, ssf, gnap, uma, acme, est, scep, did, secret-destination, scim-client, vc    

200: The application as it now stands, in application.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/discard-address

discardApplicationReturnAddress

Discard a return address a development-mode request recorded

The opposite answer to confirm-address: the address was recorded from a request in DEVELOPMENT mode and is NOT this application’s, so the mark on appReturnAddressObserved AND the address itself are taken off the entry. Product mode then refuses it as an address that is not there; development records it again, marked, if a request names it again.

An address that is not marked is REFUSED rather than removed — discarding is not the door for taking a REGISTERED address off an entry, and remove is, which says so.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attribute one of oauthRedirectUri, samlAssertionConsumerService, wsfedReplyUrl, gnapFinishUri yes  
value string yes  

200: The application as it now stands, without the address or its mark.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/export-ldif

exportApplicationLdif

Export one application’s entry as an LDIF file

Answers the application’s directory entry as an RFC 2849 LDIF document with one record: ldif (the text) and files (the same, named and base64, which the console saves). Its DECLARED attributes only — what an administrator configures, the key-pair certificates among them; nothing this service recorded about its use (counters, sightings, observed scopes and addresses). The DN is the entry’s own; import-ldif creates the application in whichever realm it is called in.

CREDENTIAL MATERIAL IS LEFT OUT BY DEFAULT and named in leftOut. With credentials true the client secrets, the registration access token, the RFC 7523 and RFC 7522 private keys, the DID private keys, a secret destination’s write credential and the GNAP shared key are written UNENCRYPTED: each sealed value is opened, because a file sealed under this process’s key-encryption key opens nowhere else. Keep such a file as you would the secrets in it. A Kerberos service key, an enrollment key or challenge and a GNAP macaroon key are never exported: each is minted by its own subsystem and no import could write it. An audit row says whether credentials went with the file, never a value.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
credentials boolean, or one of true, false, on   Include credential material, UNENCRYPTED. False when absent.

200: ldif, files (one .ldif), the attributes written, credentials, and leftOut: the credential attributes not written.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
credentials boolean    
errors list    
errors[] string    
files list    
files[].base64 string    
files[].mime string    
files[].name string    
files[].text string    
ldif string    
leftOut list    
leftOut[] 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, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
credentials boolean    
errors list    
errors[] string    
files list    
files[].base64 string    
files[].mime string    
files[].name string    
files[].text string    
ldif string    
leftOut list    
leftOut[] string    
message string    
ok boolean yes  

POST /admin-api/applications/fga-create-policy

createApplicationFgaPolicy

Give an application its default fine-grained authorization policy

Writes the fga-default policy (one rule permitting every detail) into ou=policies for an application that has none of its own — one registered by a client, seen in development mode, or whose policy could not be written when it was created — and names it in appFgaPolicy. An application that has one is answered with it, created: false. Refused (STS-FGA-0024) when ou=policies already holds xacml.maxApplicationPolicies applications’ own policies, and (STS-FGA-0008) when it cannot be written.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: The policy and whether it was created.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

POST /admin-api/applications/fga-disable

disableApplicationFga

Stop enforcing an application’s fine-grained authorization policy

Clears appFgaEnforced. The policy is kept exactly as it is, and AuthZEN evaluations about the application are decided by the realm’s root policy again.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: enforced: false.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

POST /admin-api/applications/fga-enable

enableApplicationFga

Enforce an application’s fine-grained authorization policy

Sets appFgaEnforced: from the next request every RFC 9396 authorization detail of a type this application declares is decided by its own policy, at the authorization, PAR and token endpoints, and so is every AuthZEN evaluation whose resource resolves to it. The policy is created from fga-default first if it has none. Refused while a declared type is not covered (STS-FGA-0018, naming each type and its uncovered member paths, * for an open schema), while its policy is disabled (STS-FGA-0006) or does not parse (STS-FGA-0007), and for an application this realm does not hold (STS-FGA-0009). failure names which. Every enable, including one of an application that already enforces, also grants each holder of REMOTE_PEPS in the realm (the members of roles.remotePepGroup) membership of roles.authzenPepGroup and the application in its AuthZEN scope, where either is missing, so a remote PEP’s edge PDP may forward evaluations about it. A holder that cannot be granted is listed with why (STS-FGA-0025) and does not fail the enable. Disabling removes nothing.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: The policy it is decided by, enforced: true, and peps: the remote PEPs granted (with member and scope saying what was added), those that held both already, and those failed, each with why and code.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

POST /admin-api/applications/fga-reset-policy

resetApplicationFgaPolicy

Reset an application’s fine-grained authorization policy to the default

Rewrites the document of the application’s own policy from fga-default, under the same entry name, replacing every rule in it with one that permits every detail; its enabled flag is kept. Needs confirm (STS-FGA-0020 without it), and refused (STS-FGA-0021) for an application with no policy of its own — use fga-create-policy.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
confirm boolean, or one of true, false, on   The rewrite is meant.

200: The policy rewritten.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
created boolean    
enforced boolean    
errors list    
errors[] string    
failure string    
message string    
ok boolean yes  
peps object    
peps.authzenGroup string    
peps.failed list    
peps.failed[].dn string    
peps.failed[].kind string    
peps.failed[].member boolean    
peps.failed[].name string    
peps.failed[].scope boolean    
peps.failed[].scoped boolean    
peps.failed[].why string    
peps.granted list    
peps.granted[].dn string    
peps.granted[].kind string    
peps.granted[].member boolean    
peps.granted[].name string    
peps.granted[].scope boolean    
peps.granted[].scoped boolean    
peps.granted[].why string    
peps.group string    
peps.held list    
peps.held[].dn string    
peps.held[].kind string    
peps.held[].member boolean    
peps.held[].name string    
peps.held[].scope boolean    
peps.held[].scoped boolean    
peps.held[].why string    
peps.holders list    
peps.holders[].dn string    
peps.holders[].kind string    
peps.holders[].member boolean    
peps.holders[].name string    
peps.holders[].scope boolean    
peps.holders[].scoped boolean    
peps.holders[].why string    
peps.total integer    
peps.truncated boolean    
peps.unlocated integer    
policy string    

POST /admin-api/applications/forget

deleteApplication

Delete an application entry entirely

THE ONE OPERATION HERE THAT LOSES A FACT, which is why it is separate from revoke-registration rather than something that one does as well. The entry goes and takes its counters, its sightings and its attributes with it — for a client_id somebody typed wrong, or a realm from a test that is over.

It will reappear, EMPTY, the next time that identifier is accepted by a protocol: this registry records what this service has seen, and it is still seeing.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: A message saying what went with it.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/generate-did-key

generateApplicationDidKey

Generate a key pair for an application’s DID, publishing the public half

For an application declared for the did family: generates an ES256 (default), ES384 or EdDSA key pair, adds the public JWK to didPublicKeyJwk — with replace, after taking the keys already there off — and answers the private key, as a JWK and as PKCS#8 PEM. THIS REPLY IS THE ONLY PLACE THE PRIVATE KEY IS SHOWN: this service publishes the public half in the DID document it advertises at <base>/applications/<identifier>/did.json, and keeps the private half SEALED in didPrivateKeys to sign the application’s Domain Linkage Credentials (sign-domain-linkage). The application’s DID is did:web:<host>[:realm:<id>]:applications:<identifier>. Refused (STS-ADMIN-0837) for an unknown application, one not declared for did, or another algorithm.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
algorithm one of ES256, ES384, EdDSA    
application string yes  
replace boolean    

200: The DID, the verification method and the document’s address; the public JWK; and the private key in privateJwk and privateKeyPem.

Member Type Required What it is
algorithm string    
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
did string, or null    
documentUrl string    
errors list    
errors[] string    
kid string    
message string    
ok boolean yes  
privateJwk map   A JWK’s members, which its algorithm decides.
privateJwk.{key} list, or string, or number    
privateJwk.{key}[] string    
privateKeyPem string, or null    
publicJwk map   A JWK’s members, which its algorithm decides.
publicJwk.{key} list, or string, or number    
publicJwk.{key}[] string    
replaced boolean    
verificationMethod string    
why string    

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

Member Type Required What it is
algorithm string    
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
did string, or null    
documentUrl string    
errors list    
errors[] string    
kid string    
message string    
ok boolean yes  
privateJwk map   A JWK’s members, which its algorithm decides.
privateJwk.{key} list, or string, or number    
privateJwk.{key}[] string    
privateKeyPem string, or null    
publicJwk map   A JWK’s members, which its algorithm decides.
publicJwk.{key} list, or string, or number    
publicJwk.{key}[] string    
replaced boolean    
verificationMethod string    
why string    

POST /admin-api/applications/import-ldif

importApplicationLdif

Create an application from an LDIF file

Reads an RFC 2849 LDIF document holding ONE application record, as export-ldif writes it, and creates that application in the realm this is called in, through every check a create makes. IT NEVER OVERWRITES: an identifier already recorded here is refused, naming it.

Only declared attributes are taken; a record carrying what this service records about use (a counter, a sighting, an observed value) is refused, naming each, and so is one carrying an attribute outside the schema or a credential no import can write. Credential material in the file is sealed on the way in exactly as a typed value is; client secrets keep their ids and expiries. Give the document as ldif (its text), or as file (its name and text), which is how the console sends an uploaded file.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
file object   An uploaded LDIF file: its name and its text.
file.name string    
file.text string yes  
ldif string   The LDIF document.

200: The application created.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/inherit-claim-attributes

inheritApplicationClaimAttributes

Return an application to the realm’s directory-attribute selection for a set

Takes the application’s own selection for one set off its entry, so the realm’s selection is in force for it again.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
set one of access_token, id_token, userinfo, saml2, saml11, credential yes  

200: inherited: true.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
inherited boolean    
message string    
ok boolean yes  
set string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
inherited boolean    
message string    
ok boolean yes  
set string    

POST /admin-api/applications/issue-signing-certificate

issueApplicationSigningCertificate

Issue an application a message-signing certificate from this realm’s CA

Generates a key pair and certifies it from the realm’s message-signing Issuing CA with digitalSignature only and urn:sts:application:<identifier> as its subjectAltName. A WS-Trust request whose WS-Security signature over the SOAP Body and Timestamp verifies under it authenticates the application as its requester; it signs nobody in over TLS (#521).

THIS REPLY IS THE ONLY COPY OF THE PRIVATE KEY. files holds a PKCS#12 (base64), an encrypted PKCS#8 PEM key and the PEM chain, all protected by password, which is neither stored nor audited. Refused past pki.messageSigningCertificateMax valid certificates (STS-PKI-0220), for a key algorithm outside rsa-2048, rsa-3072, ec-p256, ec-p384, for an application the registry does not hold (STS-ADMIN-0904), and in a realm with no certificate authority.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
confirm string    
days integer    
keyAlg one of rsa-2048, rsa-3072, ec-p256, ec-p384    
label string    
password string yes  

200: The certificate (serial, subject, thumbprint, PEM and chain, its urn:sts: name), the three files, and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string    
certificate.chainPem list, or string    
certificate.chainPem[] string    
certificate.implicitName string    
certificate.keyAlg string    
certificate.label string, or null    
certificate.notAfter string    
certificate.notBefore string    
certificate.serialHex string    
certificate.subject string    
certificate.thumbprint string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
files object    
files.chain object    
files.chain.base64 string    
files.chain.mime string    
files.chain.name string    
files.chain.text string    
files.key object    
files.key.base64 string    
files.key.mime string    
files.key.name string    
files.key.text string    
files.pkcs12 object    
files.pkcs12.base64 string    
files.pkcs12.mime string    
files.pkcs12.name string    
files.pkcs12.text string    
message string    
ok boolean yes  
purpose string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string    
certificate.chainPem list, or string    
certificate.chainPem[] string    
certificate.implicitName string    
certificate.keyAlg string    
certificate.label string, or null    
certificate.notAfter string    
certificate.notBefore string    
certificate.serialHex string    
certificate.subject string    
certificate.thumbprint string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
files object    
files.chain object    
files.chain.base64 string    
files.chain.mime string    
files.chain.name string    
files.chain.text string    
files.key object    
files.key.base64 string    
files.key.mime string    
files.key.name string    
files.key.text string    
files.pkcs12 object    
files.pkcs12.base64 string    
files.pkcs12.mime string    
files.pkcs12.name string    
files.pkcs12.text string    
message string    
ok boolean yes  
purpose string    

POST /admin-api/applications/issue-software-statement

issueApplicationSoftwareStatement

Sign a software statement for an application, as this realm

Signs an RFC 7591 section 2.3 software statement with this realm’s key and writes it onto the entry as oauthIssuedSoftwareStatement, replacing the one before. The application is the software PUBLISHER: hand the statement to whoever ships the software, and a client presenting it at POST /oauth2/register is registered with the members it fixes — they take precedence over the registration’s own JSON (section 3.1.1), and whatever the statement does not fix, the client chooses.

WHAT IS SIGNED: metadata (RFC 7591 client metadata, e.g. redirect_uris, grant_types, token_endpoint_auth_method), with software_id defaulting to the application’s identifier; iss is the issuer this realm publishes at the address THIS REQUEST arrived on, sub the application, iat, a jti, and exp after lifetimeSeconds (oauth2.softwareStatementLifetimeS when omitted; 0 for none). The header is typ: software-statement+jwt, which is how this service tells its statements from its other JWTs. A JWT claim or a member only registration assigns (client_id, the secret, the registration access token) is refused, and so is an address a registration would refuse.

IT IS A TRUSTED STATEMENT EVERYWHERE IN THIS REALM: nothing has to be declared for it, and where oauth2.softwareStatementOpensRegistration is on it admits a client to an endpoint closed to everybody else (product mode with oauth2.openRegistration off). It stops verifying when it expires or when the realm’s signing key is replaced — in development mode, every restart. NOT A SECRET: a statement ships with the software.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes The publisher’s identifier, exactly as the registry holds it.
lifetimeSeconds integer, or string   Seconds until exp; 0 for no expiry. Defaults to oauth2.softwareStatementLifetimeS.
metadata object, or string   The client metadata the statement fixes, as an object or as JSON text.

200: The statement in softwareStatement, its signed claims, and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims any JSON   A software statement’s claims: RFC 7591 client metadata the operator asked it to fix, beside its registered claims. A software statement’s claims: RFC 7591 client metadata the operator asked it to fix, beside its registered claims.
errors list    
errors[] string    
message string    
ok boolean yes  
softwareStatement string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims any JSON   A software statement’s claims: RFC 7591 client metadata the operator asked it to fix, beside its registered claims. A software statement’s claims: RFC 7591 client metadata the operator asked it to fix, beside its registered claims.
errors list    
errors[] string    
message string    
ok boolean yes  
softwareStatement string    

POST /admin-api/applications/issue-tls-client-certificate

issueApplicationTlsClientCertificate

Issue an application a TLS client certificate from this realm’s CA

Generates a key pair and certifies it from the realm’s tls-client Issuing CA with clientAuth, the application’s identifier as the common name and urn:sts:application:<identifier> as its subjectAltName — the name RFC 8705’s IMPLICIT mapping reads, so the certificate authenticates the application under tls_client_auth with nothing registered, and every access token issued on a connection presenting it carries cnf["x5t#S256"].

THIS REPLY IS THE ONLY COPY OF THE PRIVATE KEY. files holds a PKCS#12 (base64), an encrypted PKCS#8 PEM key and the PEM chain, all protected by password, which is neither stored nor audited. Refused past pki.applicationTlsClientCertificateMax valid certificates, for a key algorithm outside rsa-2048, rsa-3072, ec-p256, ec-p384, and in a realm with no certificate authority.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
confirm string    
days integer    
keyAlg one of rsa-2048, rsa-3072, ec-p256, ec-p384    
label string    
password string yes  

200: The certificate (serial, subject, thumbprint, PEM and chain, the implicit name), the three files, and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string    
certificate.chainPem list, or string    
certificate.chainPem[] string    
certificate.implicitName string    
certificate.keyAlg string    
certificate.label string, or null    
certificate.notAfter string    
certificate.notBefore string    
certificate.serialHex string    
certificate.subject string    
certificate.thumbprint string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
files object    
files.chain object    
files.chain.base64 string    
files.chain.mime string    
files.chain.name string    
files.chain.text string    
files.key object    
files.key.base64 string    
files.key.mime string    
files.key.name string    
files.key.text string    
files.pkcs12 object    
files.pkcs12.base64 string    
files.pkcs12.mime string    
files.pkcs12.name string    
files.pkcs12.text string    
message string    
ok boolean yes  
purpose string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string    
certificate.chainPem list, or string    
certificate.chainPem[] string    
certificate.implicitName string    
certificate.keyAlg string    
certificate.label string, or null    
certificate.notAfter string    
certificate.notBefore string    
certificate.serialHex string    
certificate.subject string    
certificate.thumbprint string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
files object    
files.chain object    
files.chain.base64 string    
files.chain.mime string    
files.chain.name string    
files.chain.text string    
files.key object    
files.key.base64 string    
files.key.mime string    
files.key.name string    
files.key.text string    
files.pkcs12 object    
files.pkcs12.base64 string    
files.pkcs12.mime string    
files.pkcs12.name string    
files.pkcs12.text string    
message string    
ok boolean yes  
purpose string    

POST /admin-api/applications/load-resource-metadata

loadProtectedResourceMetadata

Read an RFC 9728 protected resource metadata document and answer with the application it describes

Give ONE of document (the JSON, as text or as an object) or url (where it is published). It is parsed and checked, compared with this trust realm, and answered with plan: the application it describes — name, oauthPermissionBaseUri and oauthAudience from resource, one permission per scopes_supported value with the resource prefix taken off, a client_id generated at random, and oauth2 as the declared family.

IT CREATES NOTHING. Create the application with create, passing those values in fields together with oauthResourceMetadata (the document, as JSON) and, where it was fetched, oauthResourceMetadataUrl. Every value may be changed first — this answer is a proposal.

authorizationServers compares the document’s authorization_servers with the issuers this realm’s authorization servers publish at the address this request arrived on: allMatched when every one is this realm’s, anyUnmatched otherwise. A mismatch is reported and is NOT a refusal.

A FETCH FOLLOWS THE OUTBOUND POLICY: federation.outbound must be on, https with the certificate verified (#171), no redirect followed, federation.maxResponseBytes and federation.outboundTimeoutMs. In product mode the host may not resolve to a loopback, private, link-local or reserved address, and a document whose resource is not the identifier its well-known URL was built from (RFC 9728 section 3.3), or is not https, is refused; development mode reports both in warnings and answers. A malformed document is refused in both modes.

The console sends an uploaded document as file (its name and text); a JSON caller sends document instead.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
document string, or object   The protected resource metadata document, as JSON text or as a JSON object.
file object   An uploaded document: its file name and its text, which is how the console sends the file it was given.
file.name string    
file.text string yes  
url string   Where the document is published, usually https://<host>/.well-known/oauth-protected-resource[/<path>].

200: The document, its members, the section 3.3 verdict, the authorization-server comparison and the proposed application in plan.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
authorizationServers object    
authorizationServers.allMatched boolean    
authorizationServers.anyUnmatched boolean    
authorizationServers.listed integer    
authorizationServers.matched integer    
authorizationServers.realm any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
authorizationServers.rows list    
authorizationServers.rows[].authorizationServer string    
authorizationServers.rows[].issuer list, or string, or number, or boolean, or null    
authorizationServers.rows[].issuer[] string, or number, or boolean    
authorizationServers.rows[].matched boolean    
changed list, or boolean    
changed[] string    
compact string    
contentType string    
document any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
errors list    
errors[] string    
extensions list    
extensions[] string    
filename string    
members list    
members[].known boolean    
members[].maps string    
members[].member string    
members[].problem string, or null    
members[].type string    
members[].value any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
members[].what string    
message string    
ok boolean yes  
plan object    
plan.audience string    
plan.baseUri string    
plan.clientId string    
plan.detailsTypeLines list    
plan.detailsTypeLines[] string    
plan.identifier string    
plan.name string    
plan.permissionLines list    
plan.permissionLines[] string    
plan.permissions list    
plan.permissions[] any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
plan.protocols list    
plan.protocols[] string    
plan.warnings list    
plan.warnings[] string    
pretty string    
resourceCheck object    
resourceCheck.checked boolean    
resourceCheck.expected list    
resourceCheck.expected[] string    
resourceCheck.matches boolean, or null    
resourceCheck.wellKnownUrl string, or null    
resourceCheck.why string    
signedMetadata any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
source string    
status number    
url string    
warnings list    
warnings[] string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
authorizationServers object    
authorizationServers.allMatched boolean    
authorizationServers.anyUnmatched boolean    
authorizationServers.listed integer    
authorizationServers.matched integer    
authorizationServers.realm any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
authorizationServers.rows list    
authorizationServers.rows[].authorizationServer string    
authorizationServers.rows[].issuer list, or string, or number, or boolean, or null    
authorizationServers.rows[].issuer[] string, or number, or boolean    
authorizationServers.rows[].matched boolean    
changed list, or boolean    
changed[] string    
compact string    
contentType string    
document any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
errors list    
errors[] string    
extensions list    
extensions[] string    
filename string    
members list    
members[].known boolean    
members[].maps string    
members[].member string    
members[].problem string, or null    
members[].type string    
members[].value any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
members[].what string    
message string    
ok boolean yes  
plan object    
plan.audience string    
plan.baseUri string    
plan.clientId string    
plan.detailsTypeLines list    
plan.detailsTypeLines[] string    
plan.identifier string    
plan.name string    
plan.permissionLines list    
plan.permissionLines[] string    
plan.permissions list    
plan.permissions[] any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
plan.protocols list    
plan.protocols[] string    
plan.warnings list    
plan.warnings[] string    
pretty string    
resourceCheck object    
resourceCheck.checked boolean    
resourceCheck.expected list    
resourceCheck.expected[] string    
resourceCheck.matches boolean, or null    
resourceCheck.wellKnownUrl string, or null    
resourceCheck.why string    
signedMetadata any JSON   An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s. An RFC 9728 document as the resource published it, which may carry extensions and a signed form: the document’s, not this service’s.
source string    
status number    
url string    
warnings list    
warnings[] string    

GET /admin-api/applications/new

getNewApplicationForm

The vocabulary a new application may be created with, and where it would land

The eight KINDS and the fourteen PROTOCOL FAMILIES a create takes, each with what it means, the FIELDS the console’s form is drawn from (declarations — the per-protocol identifiers and the redirect URIs, deduped by attribute and each naming the families it serves), plus the container DN a new entry would be created under and how many that container will hold.

It creates nothing — the create is POST /admin-api/applications/create. This is the list that call validates against, published so that a caller learns what it may send from the service rather than from a copy of the list in a document.

The container is THIS REALM’S. The embedded directory is per trust realm, so /realm/acme/admin-api/applications/new answers with acme’s ou=applications and an application created there is invisible to every other realm — including in an ldapsearch, which reaches it only under that realm’s base DN.

Declaring a protocol family grants and refuses nothing. No endpoint in this service reads appAllowedProtocol: an application declared for SAML 2.0 alone is still issued an access token. It is a record of intent on the entry, and it is deliberately not a permission — a service that refused a protocol would remove a test case rather than add one. The configuration that DOES take effect is in editable.

Mirrors GET /admin/applications/new on the admin console.

Scope: admin:read.

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.

200: The two vocabularies, the fields a create may carry, the container and the realm.

Member Type Required What it is
applicationCount integer    
container string, or null    
declarations list    
declarations[].attribute string    
declarations[].editable string, or boolean    
declarations[].everyFamily boolean    
declarations[].families list    
declarations[].families[].id string    
declarations[].families[].label string    
declarations[].kind string    
declarations[].role string    
declarations[].sensitive boolean    
declarations[].what string    
defaultSecretLifetimeDays number    
directory boolean    
editable list    
editable[].families list    
editable[].families[] string    
editable[].mode string, or boolean    
editable[].name string    
editable[].sensitive boolean    
familyChoices list    
familyChoices[].families list    
familyChoices[].families[] string    
familyChoices[].id string    
familyChoices[].kind string    
familyChoices[].label string    
familyChoices[].what string    
fieldGroups list    
fieldGroups[].families list    
fieldGroups[].families[] string    
fieldGroups[].id string    
fieldGroups[].label string    
fields list    
fields[].attribute string    
fields[].choices list    
fields[].choices[] string    
fields[].declaration boolean    
fields[].described object    
fields[].described.appconfigPath string    
fields[].described.csvValueNotes map   The sentence beside each of a list’s values.
fields[].described.csvValueNotes.{key} string    
fields[].described.csvValues list    
fields[].described.csvValues[] string    
fields[].described.default list, or string, or number, or boolean, or null    
fields[].described.default[] string    
fields[].described.description string    
fields[].described.editRefusal string    
fields[].described.editable boolean    
fields[].described.enumValues list    
fields[].described.enumValues[] string    
fields[].described.env string, or null    
fields[].described.group string    
fields[].described.key string    
fields[].described.label string    
fields[].described.legacyEnv string, or null    
fields[].described.masked boolean    
fields[].described.max number    
fields[].described.min number    
fields[].described.ordered boolean    
fields[].described.overridden boolean    
fields[].described.realmSettable boolean    
fields[].described.restartReason string    
fields[].described.selectAll object    
fields[].described.selectAll.aloneWhileOn list    
fields[].described.selectAll.aloneWhileOn[].canBeOn boolean    
fields[].described.selectAll.aloneWhileOn[].on boolean    
fields[].described.selectAll.aloneWhileOn[].setting string    
fields[].described.selectAll.aloneWhileOn[].values list    
fields[].described.selectAll.aloneWhileOn[].values[] string    
fields[].described.selectAll.onlyWhileOn list    
fields[].described.selectAll.onlyWhileOn[].canBeOn boolean    
fields[].described.selectAll.onlyWhileOn[].on boolean    
fields[].described.selectAll.onlyWhileOn[].setting string    
fields[].described.selectAll.onlyWhileOn[].values list    
fields[].described.selectAll.onlyWhileOn[].values[] string    
fields[].described.source string    
fields[].described.step number    
fields[].described.text string    
fields[].described.type string    
fields[].described.value list, or string, or number, or boolean, or null    
fields[].described.value[] string    
fields[].editable string, or boolean    
fields[].everyFamily boolean    
fields[].example string, or null    
fields[].families list    
fields[].families[] string    
fields[].group string    
fields[].inSimple boolean    
fields[].long boolean    
fields[].overrides string    
fields[].primaryName boolean    
fields[].section string    
fields[].sectionLabel string    
fields[].sensitive boolean    
fields[].simple boolean    
fields[].type string    
fields[].what string    
kinds list    
kinds[].kind string    
kinds[].label string    
kinds[].what string    
longTextAttributes list    
longTextAttributes[] string    
max number, or null    
persistence object    
persistence.mode string    
persistence.persistsDirectory boolean    
protocols list    
protocols[].deliveryAttribute string    
protocols[].eventsAttribute string    
protocols[].id string    
protocols[].identifierAttribute string    
protocols[].kind string    
protocols[].kinds list    
protocols[].kinds[] string    
protocols[].label string    
protocols[].logoutAttribute string    
protocols[].redirectAttribute string    
protocols[].secretAttribute string    
protocols[].what string    
realm object    
realm.id string    
realm.name string    
resourceMetadataImport object    
resourceMetadataImport.acceptsNonconforming boolean    
resourceMetadataImport.dialsInternalAddresses boolean    
resourceMetadataImport.wellKnown string    

POST /admin-api/applications/refresh-metadata

refreshApplicationMetadata

Fetch this service provider’s SAML metadata and consume it

Dials the samlSpMetadataUrl ON THE ENTRY — never a URL in the request body — and CONSUMES the document exactly as POST /admin-api/saml2/upload-metadata does: its endpoints become REGISTERED return addresses, its signing certificates what its requests are verified against, its encryption certificate what an assertion is encrypted to, and its NameIDFormats, AuthnRequestsSigned and WantAssertionsSigned are applied. That operation lists what is refused.

IT IS THE ONLY OPERATION IN THIS API THAT MAKES AN OUTBOUND REQUEST, and the second surface in this service that makes one at all — federation is the other. The same refusals apply: https with the certificate verified (the three federation.outbound… transport settings, #171), a timeout of federation.outboundTimeoutMs, no redirects followed, and a size cap.

ISSUING NEVER FETCHES. This writes the certificate onto the entry and an assertion reads the entry, so no sign-in waits on somebody else’s web server.

A FAILURE CHANGES NOTHING — not the document, not the certificate — so an application that was working does not stop working because a metadata host was down.

For ENCRYPTION the use="encryption" KeyDescriptor is taken, falling back to one with no use at all; a use="signing" descriptor is never an encryption key, and is registered as a signing certificate.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: What the document said: its entityID, which KeyDescriptor the certificate came from, and the endpoints it describes.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
assertionConsumerServices list    
assertionConsumerServices[] list, or string, or number, or boolean, or null    
assertionConsumerServices[][] string, or number, or boolean    
authnRequestsSigned boolean    
cacheDuration string, or null    
certificateUse string    
changed list, or boolean    
changed[] string    
entityId string    
errors list    
errors[] string    
how string    
message string    
nameIdFormats list    
nameIdFormats[] string    
ok boolean yes  
signature string    
signingCertificates integer    
singleLogoutServices list    
singleLogoutServices[] list, or string, or number, or boolean, or null    
singleLogoutServices[][] string, or number, or boolean    
skipped list    
skipped[] string    
url string    
validUntil string, or null    
wantAssertionsSigned boolean    
why string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
assertionConsumerServices list    
assertionConsumerServices[] list, or string, or number, or boolean, or null    
assertionConsumerServices[][] string, or number, or boolean    
authnRequestsSigned boolean    
cacheDuration string, or null    
certificateUse string    
changed list, or boolean    
changed[] string    
entityId string    
errors list    
errors[] string    
how string    
message string    
nameIdFormats list    
nameIdFormats[] string    
ok boolean yes  
signature string    
signingCertificates integer    
singleLogoutServices list    
singleLogoutServices[] list, or string, or number, or boolean, or null    
singleLogoutServices[][] string, or number, or boolean    
skipped list    
skipped[] string    
url string    
validUntil string, or null    
wantAssertionsSigned boolean    
why string    

POST /admin-api/applications/regenerate-secret

regenerateApplicationClientSecret

Mint a new client secret for an application, replacing every one it holds

Mints oauth2.registeredSecretBytes random bytes, base64url — the way POST /oauth2/register mints one — as the application’s ONLY secret, a record on oauthClientSecret expiring after oauth2.clientSecretLifetimeDays days (never at 0), and into the stored RFC 7591 registration document where there is one.

EVERY SECRET IT HELD STOPS AUTHENTICATING AT ONCE, wherever the token endpoint checks a secret (RFC 9700 mode, product mode). THIS REPLY IS THE ONE PLACE THE NEW VALUE IS HANDED OUT BY THIS ACT — the audit row names the attribute and never the value — though GET /admin-api/applications?application= reads the entry back for an admin:read token, as it always has.

sts-api-client is REFUSED while adminApi.clientSecret pins its secret: every token for this API is minted with that setting, and seeding never writes over an existing entry.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: The new secret in clientSecret, its secretId and expiresAt, whether one was replaced, and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

POST /admin-api/applications/remove

removeApplicationValue

Remove a value from a multi-valued attribute

The inverse of add. Removing the LAST value takes the attribute with it, which is what the LDAP modify handler does for every other entry in this directory and what an operator reading it with an LDAP client will expect.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attribute one of appCorsOrigin, appAllowedProtocol, oauthClientId, oauthAudience, oauthRedirectUri, oauthClaimsRedirectUri, oauthPostLogoutRedirectUri, oauthGrantType, oauthResponseType, oauthAllowedTokenResponseTypes, oauthScope, oauthAllowedScope, oauthPermission, oauthRoleGatedPermission, oauthDelegatedPermission, oauthGlobalConsent, oauthTokenEndpointAuthMethod, oauthRequestUri, oauthAuthorizationDetailsType, oauthAuthorizationDetailsTypes, authzenAttribute, appAuthzenApplication, appAuthzenCallbackUri, oauthAssertionIssuer, oauthSamlAssertionIssuer, oauthSoftwareStatementIssuer, samlEntityId, samlAssertionConsumerService, samlSingleLogoutService, samlSigningCertificate, oauthAccessTokenClaim, appRequiredRole, appAllowedToDelegateTo, appAllowedToActOnBehalfOf, appDelegationSubjectGroup, appDelegationSemantics, wsfedRealm, wsfedReplyUrl, wsfedSignOutUri, wstrustAppliesTo, wstrustJwtScope, krb5ServicePrincipalName, krb5S4uSelfRealm, oid4vpClientId, federationPartnerId, ldapBindDn, scimClientId, acmeAllowedProfiles, estAllowedProfiles, scepAllowedProfiles, didPublicKeyJwk, didService, didAlsoKnownAs, scimClientScopeGroups, scimClientGroups, scimClientCells, ssfReceiverId, ssfDeliveryEndpoint, ssfAllowedEvents, gnapFinishUri, gnapInteractionStartModes, gnapAllowedAccess, gnapResourceServerUri, spiffeWorkloadId, appFederationRelationship yes  
value string yes  

200: The application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

POST /admin-api/applications/remove-access-type

removeApplicationAccessType

Take an access type off a resource application

Removes the application’s definition of type from the access-type catalogue. A right of the type is then refused by RFC 9396 in every mode and by GNAP in product mode. Refused (STS-REG-0295) for a type the application does not declare.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
type string yes  

200: The application and the type removed.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

POST /admin-api/applications/remove-access-type-row

removeApplicationAccessTypeRow

Take one row off an access type’s XACML mapping

Removes the row mapping path from type’s xacml member. Refused (STS-FGA-0023) for a path no row maps, and (STS-FGA-0019) on an application that enforces fine-grained authorization when the member would be left neither mapped nor in notForPolicy.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
path string yes  
type string yes  

200: The definition written, in definition.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

POST /admin-api/applications/remove-certificate

removeApplicationCertificate

Take a stored certificate off an application’s entry

Removes one certificate from the application’s userCertificate, named by the SHA-256 of its DER (as credentials.stored of GET /admin-api/applications?application= lists it). From then on it authenticates nobody (#1227). Refused for a SHA-256 the entry does not store (STS-ADMIN-0900) and for an application the registry does not hold (STS-ADMIN-0906).

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes The application’s identifier, exactly as this registry holds it.
sha256 string yes The SHA-256 of the certificate’s DER, hex.

200: The certificates the entry stores now.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificates list    
certificates[].expired boolean    
certificates[].issuer string    
certificates[].notAfter string    
certificates[].notBefore string    
certificates[].readable boolean    
certificates[].serialNumber string    
certificates[].sha256 string    
certificates[].subject string    
changed list, or boolean    
changed[] string    
dn string, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
rule string    
sha256 string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificates list    
certificates[].expired boolean    
certificates[].issuer string    
certificates[].notAfter string    
certificates[].notBefore string    
certificates[].readable boolean    
certificates[].serialNumber string    
certificates[].sha256 string    
certificates[].subject string    
changed list, or boolean    
changed[] string    
dn string, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
rule string    
sha256 string    

POST /admin-api/applications/remove-custom-claim

removeApplicationCustomClaim

Take one of an application’s own custom claims or SAML attributes off

Removes the application’s row of that name from one of its claim sets. The realm’s row of the same name, if there is one, is issued again. Refused (STS-REG-0206) for a name the application does not hold.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
name string yes  
set one of access_token, id_token, userinfo, saml2, saml11, kerberos-pac, gnap_access_token yes  

200: The application’s rows for that set after the change, in claims.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims list    
claims[].attribute string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value list, or string, or number, or boolean, or null    
claims[].value[] string, or number, or boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
set string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims list    
claims[].attribute string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value list, or string, or number, or boolean, or null    
claims[].value[] string, or number, or boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
set string    

POST /admin-api/applications/remove-owner

removeApplicationOwner

Take one owner off an application

Takes one appOwner value off the application and writes at once (#604). owner is the DN as listed; one not listed is refused.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
owner string yes The owner’s DN.

200: The application’s owners as they now stand (owners).

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
owners list    
owners[].dn string    
owners[].kind string    
owners[].name string    
owners[].present boolean    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
owner string    
owners list    
owners[].dn string    
owners[].kind string    
owners[].name string    
owners[].present boolean    

POST /admin-api/applications/remove-secret

removeApplicationClientSecret

Remove one client secret, by its id

Removes the secret whose id is secret (the ids are in the application’s credentials.clientSecret.secrets); it stops authenticating at once. The secret adminApi.clientSecret pins on sts-api-client is refused.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
secret string yes  

200: How many secrets are left, and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

POST /admin-api/applications/reveal-secret

revealApplicationSecret

Hand back one credential of an application: a client secret by its id, the registration access token, or a sealed key by its attribute

The one way to read a credential this registry holds: GET /admin-api/applications answers each secret’s id and expiry and never its value. secret is a client secret’s id (the ids are in the application’s credentials.clientSecret.secrets), registration-access-token, or the attribute of a sealed credential the application holds: oauthAssertionPrivateKey or oauthSamlAssertionPrivateKey (the RFC 7523 and RFC 7522 signing keys /admin-api/pki/issue put there), gnapSymmetricKey, gnapMacaroonKey. It needs admin:write and writes an audit row naming what was revealed — never the value. Nothing is changed.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
secret string yes  

200: The value, with the application and secret it belongs to.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
secret string    
value string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
secret string    
value string    

POST /admin-api/applications/revoke-registration

revokeApplicationRegistration

Withdraw an RFC 7591 registration, keeping the entry

RFC 7592’s delete reached from here instead of from the client that holds the registration access token — the same function, so the outcome is the same one rather than a second reading of what “unregistered” means.

The ENTRY stays, with everything it had recorded; the client_secret, the registration access token and the registration document go. Losing that an application was ever here because its registration was withdrawn would be losing the fact rather than the configuration.

Afterwards RFC 9700 mode treats it as an unregistered, PUBLIC client: PKCE is required of it, its secret is no longer checked, and its redirect_uri is judged against the oauth2.redirectUris setting rather than against its own list.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: The application as it now stands, with registered false.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] 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
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  

POST /admin-api/applications/revoke-signing-certificate

revokeApplicationSigningCertificate

Revoke one of an application’s message-signing certificates

Revokes a certificate issue-signing-certificate issued to THIS application — a serial belonging to anybody else, or one of its TLS client certificates, matches nothing (STS-PKI-0221) — onto the Issuing CA’s CRL and OCSP responder. A WS-Trust request signed with it is refused from then on.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
reason one of cessationOfOperation, keyCompromise    
serialHex string yes  

200: The revoked certificate, the reason, and the application as it now stands.

Member Type Required What it is
already boolean   True when the certificate was already revoked. The earlier entry is kept and its date does not move.
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string, or null    
certificate.createdAt string, or number, or null    
certificate.keyAlg string, or null    
certificate.label string, or null    
certificate.notAfter string, or number, or null    
certificate.notBefore string, or number, or null    
certificate.reason string, or null    
certificate.revokedAt string, or number, or null    
certificate.serialHex string    
certificate.slot string, or number, or null    
certificate.state string    
certificate.subject string, or null    
certificate.thumbprint string, or null    
changed list, or boolean    
changed[] string    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode number    
entry.reasonWhat string    
entry.revokedAt string, or number    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
reason string    
why string    

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

Member Type Required What it is
already boolean   True when the certificate was already revoked. The earlier entry is kept and its date does not move.
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string, or null    
certificate.createdAt string, or number, or null    
certificate.keyAlg string, or null    
certificate.label string, or null    
certificate.notAfter string, or number, or null    
certificate.notBefore string, or number, or null    
certificate.reason string, or null    
certificate.revokedAt string, or number, or null    
certificate.serialHex string    
certificate.slot string, or number, or null    
certificate.state string    
certificate.subject string, or null    
certificate.thumbprint string, or null    
changed list, or boolean    
changed[] string    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode number    
entry.reasonWhat string    
entry.revokedAt string, or number    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
reason string    
why string    

POST /admin-api/applications/revoke-tls-client-certificate

revokeApplicationTlsClientCertificate

Revoke one of an application’s TLS client certificates

Revokes a certificate issue-tls-client-certificate issued to THIS application — a serial belonging to anybody else matches nothing — onto the Issuing CA’s CRL and OCSP responder. The certificate stops authenticating the application at the token endpoint at once. An access token already bound to it stays usable until it expires: a resource server checks the binding, not revocation (RFC 8705 section 6.2).

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
reason one of cessationOfOperation, keyCompromise    
serialHex string yes  

200: The revoked certificate, the reason, and the application as it now stands.

Member Type Required What it is
already boolean   True when the certificate was already revoked. The earlier entry is kept and its date does not move.
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string, or null    
certificate.createdAt string, or number, or null    
certificate.keyAlg string, or null    
certificate.label string, or null    
certificate.notAfter string, or number, or null    
certificate.notBefore string, or number, or null    
certificate.reason string, or null    
certificate.revokedAt string, or number, or null    
certificate.serialHex string    
certificate.slot string, or number, or null    
certificate.state string    
certificate.subject string, or null    
certificate.thumbprint string, or null    
changed list, or boolean    
changed[] string    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode number    
entry.reasonWhat string    
entry.revokedAt string, or number    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
reason string    
why string    

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

Member Type Required What it is
already boolean   True when the certificate was already revoked. The earlier entry is kept and its date does not move.
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
certificate object    
certificate.certificatePem string, or null    
certificate.createdAt string, or number, or null    
certificate.keyAlg string, or null    
certificate.label string, or null    
certificate.notAfter string, or number, or null    
certificate.notBefore string, or number, or null    
certificate.reason string, or null    
certificate.revokedAt string, or number, or null    
certificate.serialHex string    
certificate.slot string, or number, or null    
certificate.state string    
certificate.subject string, or null    
certificate.thumbprint string, or null    
changed list, or boolean    
changed[] string    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode number    
entry.reasonWhat string    
entry.revokedAt string, or number    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
reason string    
why string    

POST /admin-api/applications/rotate-secret

rotateApplicationClientSecret

Add a new client secret, keeping the others working for an overlap

Adds a new secret, as add-secret does with the default lifetime, and moves every UNEXPIRED secret the application holds to expire when oauth2.clientSecretOverlapS has passed (a week by default; an earlier expiry is kept), so the client can change over without an outage. The scheduler job oauth2.client-secret-expiry removes them after. With the overlap at 0 it is a regeneration. Refused past oauth2.clientSecretsMax.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  

200: The new secret in clientSecret, and overlapUntil: when the old ones stop working (ms).

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
clientSecret string    
errors list    
errors[] string    
expiresAt number    
left integer    
message string    
ok boolean yes  
overlapUntil number    
replaced boolean    
secretId string    

POST /admin-api/applications/set

setApplicationAttribute

Set a single-valued attribute

For the attributes that hold ONE value — appName, appHomePageUrl, appLaunchProtocol, description, oauthClientSecret, oauthFrontchannelLogoutUri, oauthFrontchannelLogoutSessionRequired, oauthBackchannelLogoutUri, oauthBackchannelLogoutSessionRequired, oauthPermissionBaseUri, oauthResourceMetadata, oauthResourceMetadataUrl, oauthNativeSso, oauthNativeSsoGroup, oauthBackchannelTokenDeliveryMode, oauthBackchannelClientNotificationEndpoint, oauthCommandEndpoint, oauthBackchannelAuthenticationRequestSigningAlg, oauthBackchannelUserCodeParameter, oauthSubjectType, oauthSectorIdentifierUri, oauthDidClaimWithPairwise, oauthTokenEndpointAuthSigningAlg, oauthJwks, oauthJwksUri, oauthIntrospectionSignedResponseAlg, oauthIntrospectionEncryptedResponseAlg, oauthIntrospectionEncryptedResponseEnc, oauthRequestObjectSigningAlg, oauthRequestObjectEncryptionAlg, oauthRequestObjectEncryptionEnc, oauthRequireSignedRequestObject, oauthRequirePushedAuthorizationRequests, oauthHttpSignedRequests, oauthStepUpAcrValues, oauthStepUpMaxAge, oauthIdTokenSignedResponseAlg, oauthIdTokenEncryptedResponseAlg, oauthIdTokenEncryptedResponseEnc, oauthUserinfoSignedResponseAlg, oauthUserinfoEncryptedResponseAlg, oauthUserinfoEncryptedResponseEnc, oauthAuthorizationSignedResponseAlg, oauthAuthorizationEncryptedResponseAlg, oauthAuthorizationEncryptedResponseEnc, oauthDefaultAcrValues, oauthDefaultMaxAge, oauthAssertionJwks, oauthAssertionCertificate, oauthAssertionCertificateChain, oauthAssertionPrivateKey, oauthAssertionKid, oauthAssertionExpiresAt, oauthAssertionKeySource, oauthSamlAssertionSigningCertificate, oauthSamlAssertionCertificate, oauthSamlAssertionCertificateChain, oauthSamlAssertionPrivateKey, oauthSamlAssertionThumbprint, oauthSamlAssertionExpiresAt, oauthSamlAssertionKeySource, oauthIssuedSoftwareStatement, oauthTlsClientAuthSubjectDn, oauthTlsClientAuthSanDns, oauthTlsClientAuthSanUri, oauthTlsClientAuthSanIp, oauthTlsClientAuthSanEmail, oauthTlsClientCertificateBoundAccessTokens, oauthTlsClientCertificateThumbprint, samlSpMetadataUrl, samlSpMetadata, samlEncryptionCertificate, samlSpMetadataSigningCertificate, saml2EncryptAssertion, saml2EncryptionAlgorithm, saml2KeyTransportAlgorithm, saml2EncryptLogoutNameId, oauthAccessTokenTtlS, oauthIdTokenTtlS, oauthRefreshTokenTtlS, oauthRefreshIdleSeconds, oauthClaimsAccessToken, oauthClaimsIdToken, oauthClaimsUserinfo, oauthClaimAttributesAccessToken, oauthClaimAttributesIdToken, oauthClaimAttributesUserinfo, oauthClaimsCombineAccessToken, oauthClaimsCombineIdToken, oauthClaimsCombineUserinfo, oauthPermissionClaims, oauthAccessTokenClaimsCombine, oauthRevokeRefreshOnLogout, oauthThirdPartyInitiatedLogin, oauthSpInitiatedSso, oauthInitiateLoginUri, oauthLogoUri, oauthPolicyUri, oauthTosUri, oauthTokenExchangeRefreshToken, appDefaultDelegationSemantics, appNotDelegated, appMayAct, appGroupsClaim, appGroupsClaimName, appGroupsClaimValue, appGroupsClaimFromMemberOf, wsfedAssertionLifetimeMin, saml2CustomAttributes, saml11CustomAttributes, saml2ClaimAttributes, saml11ClaimAttributes, saml2ClaimsCombine, saml11ClaimsCombine, vcCredentialClaimAttributes, saml2AssertionLifetimeMin, saml2SignAssertion, saml2SignResponse, saml2NameIdFormat, saml2ArtifactTtlS, saml11AssertionLifetimeMin, saml11SignAssertion, saml11SignResponse, saml11NameIdFormat, saml11ArtifactTtlS, saml2IdpInitiatedSso, saml2SpInitiatedSso, saml11IdpInitiatedSso, saml11SpInitiatedSso, wsfedIdpInitiatedSso, wsfedSpInitiatedSso, krb5ClaimsPac, gnapClaimsAccessToken, krb5TrustedForDelegation, krb5ForeignTgtDelegation, appRegistrationAccessToken, acmeDefaultProfile, acmeCertificateLifetimeDays, estDefaultProfile, estCertificateLifetimeDays, scepDefaultProfile, scepCertificateLifetimeDays, estBasicAuthentication, estCertificateAuthentication, estServerKeyGeneration, enrollMaxCertificates, didPrivateKeys, secretDestProvider, secretDestPayload, secretDestRegion, secretDestProject, secretDestEndpoint, secretDestMount, secretDestField, secretDestDirectory, secretDestCaCertificates, secretDestCredential, scimClientBaseUrl, scimClientEnabled, scimClientAuthMethod, scimClientUsername, scimClientPassword, scimClientTokenEndpoint, scimClientOAuthClientId, scimClientOAuthClientSecret, scimClientOAuthClientAuth, scimClientOAuthScope, scimClientOAuthResource, scimClientTlsSource, scimClientTlsCertificate, scimClientTlsPrivateKey, scimClientCaCertificates, scimClientScopeMode, scimClientScopeFilter, scimClientGroupMode, scimClientDeprovision, scimClientReconcileMinutes, scimClientJurisdiction, scimClientMaxRequestsPerSecond, ssfCaepIncludeReasons, ssfCaepReasonLanguage, ssfCaepOmitEventTimestamp, ssfRiscIncludeReasons, ssfRiscReasonLanguage, ssfRiscOmitEventTimestamp, ssfSigningAlgorithm, ssfMinVerificationInterval, ssfInactivityTimeoutS, ssfInactivityAction, ssfVerificationEveryS, ssfStreamStatusOnCreate, ssfMaxStreams, ssfMaxSubjectsPerStream, ssfMaxQueuedEvents, ssfPollMaxEvents, ssfDeadLetterMaxPerStream, ssfPushTimeoutMs, ssfPushRetries, ssfPushRetryDelayMs, gnapInstanceId, gnapKey, gnapKeyReference, gnapKeyProof, gnapMtlsTrust, gnapSymmetricKey, gnapSymmetricAlg, gnapClassId, gnapDisplayUri, gnapLogoUri, gnapBearerTokens, gnapSkipInteraction, gnapAccessTokenFormat, gnapAccessTokenLifetimeS, gnapOwnerLookupUri, gnapJweKey, gnapScopedSignals, appFederationAutoRedirect, appAuthnPolicy, appPasskeyPolicy, appLocalePolicy, appPasswordPolicy, appPostLoginPolicy, umaOwnsResources. An empty value CLEARS the attribute.

What may be changed is DECLARED and not DERIVED. Configuration — what this application is allowed to do, which is what RFC 9700 mode reads — is editable. The counters, the sightings, the kinds and the protocols are what HAPPENED, and are refused with a list of what is not: a call that could rewrite them would make this registry lie about the service’s own behaviour, in a way indistinguishable from the recording being broken. ldapmodify still reaches every attribute, which is a deliberate difference — refusing them HERE is the difference between offering an operation and merely not preventing it.

106 attributes are scoped to a PROTOCOL FAMILY and REFUSED on an application declared for none of them: oauthNativeSso (OpenID Connect), oauthNativeSsoGroup (OpenID Connect), oauthBackchannelTokenDeliveryMode (OpenID Connect), oauthBackchannelClientNotificationEndpoint (OpenID Connect), oauthCommandEndpoint (OpenID Connect), oauthBackchannelAuthenticationRequestSigningAlg (OpenID Connect), oauthBackchannelUserCodeParameter (OpenID Connect), oauthSubjectType (OpenID Connect), oauthSectorIdentifierUri (OpenID Connect), oauthDidClaimWithPairwise (OpenID Connect), oauthTokenEndpointAuthSigningAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionSignedResponseAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionEncryptedResponseAlg (OAuth 2.0, OpenID Connect), oauthIntrospectionEncryptedResponseEnc (OAuth 2.0, OpenID Connect), oauthRequestUri (OAuth 2.0, OpenID Connect), oauthRequestObjectSigningAlg (OAuth 2.0, OpenID Connect), oauthRequestObjectEncryptionAlg (OAuth 2.0, OpenID Connect), oauthRequestObjectEncryptionEnc (OAuth 2.0, OpenID Connect), oauthRequireSignedRequestObject (OAuth 2.0, OpenID Connect), oauthRequirePushedAuthorizationRequests (OAuth 2.0, OpenID Connect), oauthHttpSignedRequests (OAuth 2.0, OpenID Connect), oauthAuthorizationDetailsType (OAuth 2.0, OpenID Connect, GNAP), oauthAuthorizationDetailsTypes (OAuth 2.0, OpenID Connect), authzenAttribute (OAuth 2.0, OpenID Connect), appAuthzenApplication (OAuth 2.0, OpenID Connect), appAuthzenCallbackUri (OAuth 2.0, OpenID Connect), oauthStepUpAcrValues (OAuth 2.0, OpenID Connect), oauthStepUpMaxAge (OAuth 2.0, OpenID Connect), oauthIdTokenSignedResponseAlg (OpenID Connect), oauthIdTokenEncryptedResponseAlg (OpenID Connect), oauthIdTokenEncryptedResponseEnc (OpenID Connect), oauthUserinfoSignedResponseAlg (OpenID Connect), oauthUserinfoEncryptedResponseAlg (OpenID Connect), oauthUserinfoEncryptedResponseEnc (OpenID Connect), oauthAuthorizationSignedResponseAlg (OAuth 2.0, OpenID Connect), oauthAuthorizationEncryptedResponseAlg (OAuth 2.0, OpenID Connect), oauthAuthorizationEncryptedResponseEnc (OAuth 2.0, OpenID Connect), oauthDefaultAcrValues (OpenID Connect), oauthDefaultMaxAge (OpenID Connect), oauthThirdPartyInitiatedLogin (OAuth 2.0, OpenID Connect), oauthSpInitiatedSso (OAuth 2.0, OpenID Connect), oauthInitiateLoginUri (OAuth 2.0, OpenID Connect), oauthLogoUri (OAuth 2.0, OpenID Connect), oauthPolicyUri (OAuth 2.0, OpenID Connect), oauthTosUri (OAuth 2.0, OpenID Connect), oauthTokenExchangeRefreshToken (OAuth 2.0, OpenID Connect), vcCredentialClaimAttributes (OpenID4VCI), wstrustJwtScope (WS-Trust), krb5S4uSelfRealm (Kerberos v5), krb5ForeignTgtDelegation (Kerberos v5), secretDestProvider (Secret push destination), secretDestPayload (Secret push destination), secretDestRegion (Secret push destination), secretDestProject (Secret push destination), secretDestEndpoint (Secret push destination), secretDestMount (Secret push destination), secretDestField (Secret push destination), secretDestDirectory (Secret push destination), secretDestCaCertificates (Secret push destination), secretDestCredential (Secret push destination), scimClientBaseUrl (SCIM client (outbound provisioning)), scimClientEnabled (SCIM client (outbound provisioning)), scimClientAuthMethod (SCIM client (outbound provisioning)), scimClientUsername (SCIM client (outbound provisioning)), scimClientPassword (SCIM client (outbound provisioning)), scimClientTokenEndpoint (SCIM client (outbound provisioning)), scimClientOAuthClientId (SCIM client (outbound provisioning)), scimClientOAuthClientSecret (SCIM client (outbound provisioning)), scimClientOAuthClientAuth (SCIM client (outbound provisioning)), scimClientOAuthScope (SCIM client (outbound provisioning)), scimClientOAuthResource (SCIM client (outbound provisioning)), scimClientTlsSource (SCIM client (outbound provisioning)), scimClientTlsCertificate (SCIM client (outbound provisioning)), scimClientTlsPrivateKey (SCIM client (outbound provisioning)), scimClientCaCertificates (SCIM client (outbound provisioning)), scimClientScopeMode (SCIM client (outbound provisioning)), scimClientScopeGroups (SCIM client (outbound provisioning)), scimClientScopeFilter (SCIM client (outbound provisioning)), scimClientGroupMode (SCIM client (outbound provisioning)), scimClientGroups (SCIM client (outbound provisioning)), scimClientDeprovision (SCIM client (outbound provisioning)), scimClientReconcileMinutes (SCIM client (outbound provisioning)), scimClientJurisdiction (SCIM client (outbound provisioning)), scimClientCells (SCIM client (outbound provisioning)), scimClientMaxRequestsPerSecond (SCIM client (outbound provisioning)), ssfAllowedEvents (Shared Signals), ssfCaepIncludeReasons (Shared Signals), ssfCaepReasonLanguage (Shared Signals), ssfCaepOmitEventTimestamp (Shared Signals), ssfRiscIncludeReasons (Shared Signals), ssfRiscReasonLanguage (Shared Signals), ssfRiscOmitEventTimestamp (Shared Signals), ssfSigningAlgorithm (Shared Signals), ssfMinVerificationInterval (Shared Signals), ssfInactivityTimeoutS (Shared Signals), ssfInactivityAction (Shared Signals), ssfVerificationEveryS (Shared Signals), ssfStreamStatusOnCreate (Shared Signals), ssfMaxStreams (Shared Signals), ssfMaxSubjectsPerStream (Shared Signals), ssfMaxQueuedEvents (Shared Signals), ssfPollMaxEvents (Shared Signals), ssfDeadLetterMaxPerStream (Shared Signals), ssfPushTimeoutMs (Shared Signals), ssfPushRetries (Shared Signals), ssfPushRetryDelayMs (Shared Signals). That is unlike every other attribute here, which is inert rather than wrong on an entry that never reaches the protocol it belongs to — these decide what an ENDPOINT does for an identifier, so on an entry no request could ever name they would read as a policy that was in force. Declare the family first (protocols on the create, or add to appAllowedProtocol). Clearing one is never refused, and ldapmodify reaches them like every other attribute.

This writes the same entry LDAP writes, through the same functions, so it takes effect on the very next authorization request.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes The identifier, exactly as the registry holds it.
attribute one of appName, appHomePageUrl, appLaunchProtocol, description, oauthClientSecret, oauthFrontchannelLogoutUri, oauthFrontchannelLogoutSessionRequired, oauthBackchannelLogoutUri, oauthBackchannelLogoutSessionRequired, oauthPermissionBaseUri, oauthResourceMetadata, oauthResourceMetadataUrl, oauthNativeSso, oauthNativeSsoGroup, oauthBackchannelTokenDeliveryMode, oauthBackchannelClientNotificationEndpoint, oauthCommandEndpoint, oauthBackchannelAuthenticationRequestSigningAlg, oauthBackchannelUserCodeParameter, oauthSubjectType, oauthSectorIdentifierUri, oauthDidClaimWithPairwise, oauthTokenEndpointAuthSigningAlg, oauthJwks, oauthJwksUri, oauthIntrospectionSignedResponseAlg, oauthIntrospectionEncryptedResponseAlg, oauthIntrospectionEncryptedResponseEnc, oauthRequestObjectSigningAlg, oauthRequestObjectEncryptionAlg, oauthRequestObjectEncryptionEnc, oauthRequireSignedRequestObject, oauthRequirePushedAuthorizationRequests, oauthHttpSignedRequests, oauthStepUpAcrValues, oauthStepUpMaxAge, oauthIdTokenSignedResponseAlg, oauthIdTokenEncryptedResponseAlg, oauthIdTokenEncryptedResponseEnc, oauthUserinfoSignedResponseAlg, oauthUserinfoEncryptedResponseAlg, oauthUserinfoEncryptedResponseEnc, oauthAuthorizationSignedResponseAlg, oauthAuthorizationEncryptedResponseAlg, oauthAuthorizationEncryptedResponseEnc, oauthDefaultAcrValues, oauthDefaultMaxAge, oauthAssertionJwks, oauthAssertionCertificate, oauthAssertionCertificateChain, oauthAssertionPrivateKey, oauthAssertionKid, oauthAssertionExpiresAt, oauthAssertionKeySource, oauthSamlAssertionSigningCertificate, oauthSamlAssertionCertificate, oauthSamlAssertionCertificateChain, oauthSamlAssertionPrivateKey, oauthSamlAssertionThumbprint, oauthSamlAssertionExpiresAt, oauthSamlAssertionKeySource, oauthIssuedSoftwareStatement, oauthTlsClientAuthSubjectDn, oauthTlsClientAuthSanDns, oauthTlsClientAuthSanUri, oauthTlsClientAuthSanIp, oauthTlsClientAuthSanEmail, oauthTlsClientCertificateBoundAccessTokens, oauthTlsClientCertificateThumbprint, samlSpMetadataUrl, samlSpMetadata, samlEncryptionCertificate, samlSpMetadataSigningCertificate, saml2EncryptAssertion, saml2EncryptionAlgorithm, saml2KeyTransportAlgorithm, saml2EncryptLogoutNameId, oauthAccessTokenTtlS, oauthIdTokenTtlS, oauthRefreshTokenTtlS, oauthRefreshIdleSeconds, oauthClaimsAccessToken, oauthClaimsIdToken, oauthClaimsUserinfo, oauthClaimAttributesAccessToken, oauthClaimAttributesIdToken, oauthClaimAttributesUserinfo, oauthClaimsCombineAccessToken, oauthClaimsCombineIdToken, oauthClaimsCombineUserinfo, oauthPermissionClaims, oauthAccessTokenClaimsCombine, oauthRevokeRefreshOnLogout, oauthThirdPartyInitiatedLogin, oauthSpInitiatedSso, oauthInitiateLoginUri, oauthLogoUri, oauthPolicyUri, oauthTosUri, oauthTokenExchangeRefreshToken, appDefaultDelegationSemantics, appNotDelegated, appMayAct, appGroupsClaim, appGroupsClaimName, appGroupsClaimValue, appGroupsClaimFromMemberOf, wsfedAssertionLifetimeMin, saml2CustomAttributes, saml11CustomAttributes, saml2ClaimAttributes, saml11ClaimAttributes, saml2ClaimsCombine, saml11ClaimsCombine, vcCredentialClaimAttributes, saml2AssertionLifetimeMin, saml2SignAssertion, saml2SignResponse, saml2NameIdFormat, saml2ArtifactTtlS, saml11AssertionLifetimeMin, saml11SignAssertion, saml11SignResponse, saml11NameIdFormat, saml11ArtifactTtlS, saml2IdpInitiatedSso, saml2SpInitiatedSso, saml11IdpInitiatedSso, saml11SpInitiatedSso, wsfedIdpInitiatedSso, wsfedSpInitiatedSso, krb5ClaimsPac, gnapClaimsAccessToken, krb5TrustedForDelegation, krb5ForeignTgtDelegation, appRegistrationAccessToken, acmeDefaultProfile, acmeCertificateLifetimeDays, estDefaultProfile, estCertificateLifetimeDays, scepDefaultProfile, scepCertificateLifetimeDays, estBasicAuthentication, estCertificateAuthentication, estServerKeyGeneration, enrollMaxCertificates, didPrivateKeys, secretDestProvider, secretDestPayload, secretDestRegion, secretDestProject, secretDestEndpoint, secretDestMount, secretDestField, secretDestDirectory, secretDestCaCertificates, secretDestCredential, scimClientBaseUrl, scimClientEnabled, scimClientAuthMethod, scimClientUsername, scimClientPassword, scimClientTokenEndpoint, scimClientOAuthClientId, scimClientOAuthClientSecret, scimClientOAuthClientAuth, scimClientOAuthScope, scimClientOAuthResource, scimClientTlsSource, scimClientTlsCertificate, scimClientTlsPrivateKey, scimClientCaCertificates, scimClientScopeMode, scimClientScopeFilter, scimClientGroupMode, scimClientDeprovision, scimClientReconcileMinutes, scimClientJurisdiction, scimClientMaxRequestsPerSecond, ssfCaepIncludeReasons, ssfCaepReasonLanguage, ssfCaepOmitEventTimestamp, ssfRiscIncludeReasons, ssfRiscReasonLanguage, ssfRiscOmitEventTimestamp, ssfSigningAlgorithm, ssfMinVerificationInterval, ssfInactivityTimeoutS, ssfInactivityAction, ssfVerificationEveryS, ssfStreamStatusOnCreate, ssfMaxStreams, ssfMaxSubjectsPerStream, ssfMaxQueuedEvents, ssfPollMaxEvents, ssfDeadLetterMaxPerStream, ssfPushTimeoutMs, ssfPushRetries, ssfPushRetryDelayMs, gnapInstanceId, gnapKey, gnapKeyReference, gnapKeyProof, gnapMtlsTrust, gnapSymmetricKey, gnapSymmetricAlg, gnapClassId, gnapDisplayUri, gnapLogoUri, gnapBearerTokens, gnapSkipInteraction, gnapAccessTokenFormat, gnapAccessTokenLifetimeS, gnapOwnerLookupUri, gnapJweKey, gnapScopedSignals, appFederationAutoRedirect, appAuthnPolicy, appPasskeyPolicy, appLocalePolicy, appPasswordPolicy, appPostLoginPolicy, umaOwnsResources yes One of the editable single-valued attributes. GET /admin/ldap/applications publishes the schema with an editable member on every row.
value string   The new value; empty clears the attribute.

200: The application as it now stands, with changed saying whether anything actually differed.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

POST /admin-api/applications/set-access-type

setApplicationAccessType

Declare or replace an access type a resource application owns

Writes one oauthAuthorizationDetailsType value from named fields — the access-type catalogue read by RFC 9396 authorization_details and by GNAP access rights alike — replacing the application’s definition of the same type. A list field is an array or text with one value per line (requiredMembers is the definition’s required); schema and limits are JSON Schemas (limits a subset: type, properties, required, additionalProperties, items, enum, const, bounds, pattern, format). bearer: false makes a token carrying the type sender-constrained; maxLifetimeS caps it; derivableFrom names the types it may be derived from (RFC 9767 section 4); introspectionClaims the person’s claims the application is told at introspection. interaction (always, default, never), consentActions and acr decide, for GNAP, whether the resource owner must be asked and how strongly signed in (#432 phase 6). A definition that does not read is refused (STS-REG-0294) and the one declared stays.

xacml (rows of path, attributeId, category, dataType, multiplicity) and notForPolicy are the type’s fine-grained authorization mapping (#564), written whole here and a row at a time by set-access-type-row, remove-access-type-row and set-not-for-policy; on an application that enforces fine-grained authorization a definition leaving a member uncovered is refused (STS-FGA-0019).

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
acr string    
actions list    
actions[] string    
application string yes  
bearer boolean or string    
consentActions list    
consentActions[] string    
datatypes list    
datatypes[] string    
derivableFrom list    
derivableFrom[] string    
description string    
interaction one of always, default, never    
introspectionClaims list    
introspectionClaims[] string    
limits object or string    
locations list    
locations[] string    
maxLifetimeS integer or string    
notForPolicy list    
notForPolicy[] string    
privileges list    
privileges[] string    
requiredMembers list    
requiredMembers[] string    
schema object or string    
type string yes  
xacml list    

200: The definition written, in definition.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

POST /admin-api/applications/set-access-type-row

setApplicationAccessTypeRow

Map one member of an access type to an XACML attribute

Adds to type’s xacml mapping the row for path, or replaces the row already mapping that path: the member of an RFC 9396 detail of the type that becomes the attribute attributeId when an application’s fine-grained authorization policy decides it. category (resource by default), dataType (string by default) and multiplicity (single or bag) take AuthZEN’s catalogue names or the XACML URIs. The row is read by the mapping’s grammar before it is written, and refused (STS-FGA-0023, with field naming the member that was wrong) for a path that is not a member path or names type or a common data field, an identifier this service reserves for what it writes itself (urn:sts:xacml:*, subject-id, resource-id, action-id, the current-time attributes, or a bare directory name in a subject category), or a category, data type or multiplicity outside the set. On an application that enforces fine-grained authorization the write is also held to coverage (STS-FGA-0019).

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attributeId string yes  
category string    
dataType string    
description string    
multiplicity string    
path string yes  
type string yes  

200: The definition written, in definition.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

POST /admin-api/applications/set-claim-attributes

setApplicationClaimAttributes

Set an application’s own directory-attribute selection for a claim set or its credentials

Writes the application’s own selection of catalogue attributes for one set — access_token, id_token, userinfo, saml2, saml11, or credential (its OpenID4VCI credentials). HELD, IT REPLACES THE REALM’S SELECTION for that set: the realm’s ticked attributes are not issued to this application, and an empty attributes issues none. The catalogue is the one GET /admin-api/claims lists. Refused (STS-REG-0215) for an attribute the catalogue does not hold, or a set whose protocol the application is not declared for.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attributes list yes  
attributes[] string    
set one of access_token, id_token, userinfo, saml2, saml11, credential yes  

200: The selection now held, in attributes.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
inherited boolean    
message string    
ok boolean yes  
set string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
inherited boolean    
message string    
ok boolean yes  
set string    

POST /admin-api/applications/set-claim-selections

setApplicationClaimSelections

Set an application’s access token, ID Token and UserInfo directory-attribute selections together, writing only the ones that changed

The console’s OAuth 2.0 / OpenID Connect claims table, a column per set. Each of access_token, id_token and userinfo that is sent is the whole list of catalogue attributes that set should carry. A set sent with exactly the selection in force is LEFT AS IT IS — the realm’s, if the application was inheriting it — and a set that differs becomes the application’s own selection, replacing the realm’s for it, as set-claim-attributes writes one. A set not sent is not touched. Every set is checked before any is written. Refused (STS-REG-0215) for an attribute the catalogue does not hold, or an application not declared for OAuth 2.0 or OpenID Connect.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
access_token list    
access_token[] string    
application string yes  
id_token list    
id_token[] string    
userinfo list    
userinfo[] string    

200: Each set sent, in sets: changed, inherited and the attributes now in force.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
sets list    
sets[].attributes list    
sets[].attributes[] string    
sets[].changed boolean    
sets[].inherited boolean    
sets[].set string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
sets list    
sets[].attributes list    
sets[].attributes[] string    
sets[].changed boolean    
sets[].inherited boolean    
sets[].set string    

POST /admin-api/applications/set-custom-claim

setApplicationCustomClaim

Set one of an application’s own custom claims or SAML attributes

Adds a row to one of the application’s own claim sets — access_token, id_token, userinfo, saml2, saml11, kerberos-pac (#493: added to a service ticket for one of its SPNs) or gnap_access_token (#1250: added to a jwt-signed GNAP access token and to the JWT inside a jwt-encrypted one; the protocol’s own claims win, and groups, roles and the ticked catalogue are not added) — or replaces its row of the same name. At issuance the application’s rows are ADDED to the realm’s set and win by name. A row is a typed value (value, with ${placeholders}) or a directory attribute of the person (attribute, with multi and, for the JSON sets including gnap_access_token, type); a SAML 2.0 row may carry nameFormat, a SAML 1.1 row namespace. Held to the realm’s rules: a reserved name, an attribute that may not be released or an unknown type is refused (STS-REG-0206), as is a set whose protocol the application is not declared for.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attribute string    
multi boolean    
name string yes  
nameFormat string    
namespace string    
set one of access_token, id_token, userinfo, saml2, saml11, kerberos-pac, gnap_access_token yes  
type one of string, number, boolean, json, int64, uint64   The JSON type of an attribute row in the JSON sets, gnap_access_token among them; in kerberos-pac (#493) every row’s PAC claim type, of string, int64, uint64 and boolean.
value string    

200: The application’s rows for that set after the change, in claims.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims list    
claims[].attribute string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value list, or string, or number, or boolean, or null    
claims[].value[] string, or number, or boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
set string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
claims list    
claims[].attribute string    
claims[].multi boolean    
claims[].name string    
claims[].nameFormat string    
claims[].namespace string    
claims[].type string    
claims[].value list, or string, or number, or boolean, or null    
claims[].value[] string, or number, or boolean    
errors list    
errors[] string    
message string    
ok boolean yes  
set string    

POST /admin-api/applications/set-not-for-policy

setApplicationAccessTypeNotForPolicy

Name the members of an access type its policy deliberately never sees

Replaces type’s notForPolicy list: member paths a fine-grained authorization policy is never given, listed so that the type still counts as covered. An array, or text with one path per line or comma; empty clears the list. Refused (STS-FGA-0023) for a path the grammar does not read, or one a row maps; and (STS-FGA-0019) on an application that enforces fine-grained authorization when a member would be left uncovered.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
notForPolicy list    
notForPolicy[] string    
type string yes  

200: The definition written, in definition.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
definition any JSON   The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition. The JSON an operator wrote into an access type’s definition: a JSON Schema (RFC 9396 leaves a type’s fields to its definition), or the definition.
errors list    
errors[] string    
message string    
ok boolean yes  
type string    

POST /admin-api/applications/set-permission-claims

setApplicationPermissionClaims

Map claims to one of a resource server’s own scopes

Writes the directory attributes, from the claim catalogue GET /admin-api/claims lists, that an access token addressed to this application carries when permission — one of the permissions it exposes (oauthPermission) — was GRANTED. Granting the permission is the grant of those claims, a standard OpenID Connect claim included. They join the resource server’s declared claims and combine with the client’s as oauthAccessTokenClaimsCombine says; on a token for several resource servers only what every one wants goes in. An empty attributes maps none. Refused (STS-REG-0344) for a permission it does not expose, an attribute the catalogue does not hold, or an application not declared for OAuth 2.0 or OpenID Connect.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
attributes list yes  
attributes[] string    
permission string yes  

200: The permission’s attributes now held, in attributes, and the whole map, in mappings.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
mappings map   Each permission’s claims.
mappings.{key} list    
mappings.{key}[] string    
message string    
ok boolean yes  
permission string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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    
attributes list    
attributes[] string    
changed list, or boolean    
changed[] string    
errors list    
errors[] string    
mappings map   Each permission’s claims.
mappings.{key} list    
mappings.{key}[] string    
message string    
ok boolean yes  
permission string    

POST /admin-api/applications/sign-domain-linkage

signApplicationDomainLinkage

Sign the DID Configuration resource for one of an application’s LinkedDomains origins

The DIF Well-Known DID Configuration: one Domain Linkage Credential (JWT form), self-issued by the application’s DID with credentialSubject { id, origin }, signed with a key its DID document publishes whose private half this service kept (one generate-did-key made). Host didConfiguration at https://<origin>/.well-known/did-configuration.json. origin must be a LinkedDomains service in didService. Writes nothing. Refused (STS-VC-0115) for an application with no DID document, an origin it does not list, or no kept key.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
origin string yes  

200: The DID Configuration resource in didConfiguration, the DID, the origin, the signing key’s kid, a file name and where to host it (hostAt).

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
did string, or null    
didConfiguration object    
didConfiguration.@context list, or string, or number, or boolean, or null    
didConfiguration.@context[] string, or number, or boolean    
didConfiguration.linked_dids list    
didConfiguration.linked_dids[] string    
errors list    
errors[] string    
filename string    
hostAt string    
kid string    
message string    
ok boolean yes  
origin string    
why string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
did string, or null    
didConfiguration object    
didConfiguration.@context list, or string, or number, or boolean, or null    
didConfiguration.@context[] string, or number, or boolean    
didConfiguration.linked_dids list    
didConfiguration.linked_dids[] string    
errors list    
errors[] string    
filename string    
hostAt string    
kid string    
message string    
ok boolean yes  
origin string    
why string    

POST /admin-api/applications/update-fields

updateApplicationFields

Set several attributes of an application at once

What the Save button of an application’s field grid on the console does. Each member of fields names an editable attribute and gives what it should hold: a single-valued attribute is SET (an empty string or array clears it), and a multi-valued one has the values not given removed and the values not yet held added — exactly set, add and remove, applied per attribute, so every rule those hold still holds. An attribute whose values did not change is not written. protocols, when given, replaces the declared protocol families, and is written first, so a family-scoped attribute may be set in the same call that declares its family.

What one attribute refuses does not undo another: the reply names what was saved (changed) and every refusal, and answers 400 when there was any.

Mirrors POST /admin/applications, POST /admin/applications/new, POST /admin/applications/edit and POST /admin/applications/owners 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
application string yes  
fields object    
present list   The fields the console’s form drew, by attribute name, space or comma separated or as a list: each one is cleared when the form carries no value for it.
present[] string    
protocols list    
protocols[] string    
protocolsPresent string or boolean   Set by the console’s form, which draws the families as checkboxes: protocols is then the whole list, and none ticked means none.

200: The attributes saved (changed) and the application as it now stands.

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string    

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

Member Type Required What it is
application object, or string, or null    
application.allowedProtocols list    
application.allowedProtocols[] string    
application.attributes map   By attribute name.
application.attributes.{key} list, or string, or number, or boolean, or null    
application.attributes.{key}[] string, or number, or boolean    
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   By attribute name.
application.fields.{key} list, or string, or number, or boolean, or null    
application.fields.{key}[] string, or number, or boolean    
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 list, or boolean    
changed[] string    
errors list    
errors[] string    
message string    
ok boolean yes  
warnings list    
warnings[].attribute string    
warnings[].dropped boolean    
warnings[].reason string    
warnings[].text string    
warnings[].value string