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

getCertificates

Every certificate this trust realm holds, or one of them with every X.509 field and its trust chain

Without certificate: a LIST of every certificate this service holds in the trust realm the request was reached in — the service Root, the process branch (TLS and SPIFFE), this realm’s Intermediate, Issuing CAs and what they certified, the signing-key certificates, the certificate authority workbench, the TLS listener certificates, the SPIFFE authorities, and the key pairs issued to applications and people — one row per certificate with every place it appears.

With certificate: that certificate described WHOLE — the tbsCertificate in RFC 5280 section 4.1’s order (version, serial, inner signature algorithm, issuer and subject RDN by RDN, validity with its ASN.1 time type, the public key with its parameters and bytes, both unique identifiers, every extension decoded), the outer signature algorithm and value, both fingerprints — and chain, the path to a self-signed certificate BUILT from what this service holds by matching each issuer’s name AND verifying its signature, with chainStatus saying where and why a path stopped. Every certificate in the chain is described with the same fields.

A certificate is named by its SHA-256 fingerprint and looked up, never sent. A fingerprint of anything this realm does not hold is refused, so a certificate from another realm is reached under that realm’s prefix. Mirrors the dialog both pages open with ?certificate=.

Mirrors GET /admin/pki and GET /admin/crypto-metadata on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
certificate query string   A SHA-256 certificate fingerprint, 64 hexadecimal digits with or without colons — the fingerprint of a row of the list. Returns that certificate’s details instead of the list.
q query string   Substring of the subject, the issuer or where the certificate appears, case-insensitive.
page query integer   Which page of the match to return. CLAMPED rather than refused: a page past the end returns the last one, and the reply says which page it actually is.
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The list, or one certificate with its chain.

Member Type Required What it is
appearances list    
appearances[].label string    
appearances[].where string    
certificate object    
certificate.fields object    
certificate.fields.signatureAlgorithm object    
certificate.fields.signatureAlgorithm.name string, or null    
certificate.fields.signatureAlgorithm.oid string    
certificate.fields.signatureAlgorithm.parameters string, or null    
certificate.fields.signatureAlgorithmsAgree boolean    
certificate.fields.signatureValue object    
certificate.fields.signatureValue.hex string    
certificate.fields.signatureValue.octets integer    
certificate.fields.tbsCertificate object    
certificate.fields.tbsCertificate.extensions list    
certificate.fields.tbsCertificate.extensions[].critical boolean    
certificate.fields.tbsCertificate.extensions[].label string    
certificate.fields.tbsCertificate.extensions[].name string    
certificate.fields.tbsCertificate.extensions[].oid string    
certificate.fields.tbsCertificate.extensions[].parseError string, or null    
certificate.fields.tbsCertificate.extensions[].text string, or null    
certificate.fields.tbsCertificate.extensions[].value any JSON   An X.509 extension’s decoded value, on a certificate that may be anybody’s: its shape is that extension’s ASN.1 module’s. An X.509 extension’s decoded value, on a certificate that may be anybody’s: its shape is that extension’s ASN.1 module’s.
certificate.fields.tbsCertificate.issuer object    
certificate.fields.tbsCertificate.issuer.attributes list    
certificate.fields.tbsCertificate.issuer.attributes[].label string    
certificate.fields.tbsCertificate.issuer.attributes[].oid string    
certificate.fields.tbsCertificate.issuer.attributes[].short string    
certificate.fields.tbsCertificate.issuer.attributes[].value string    
certificate.fields.tbsCertificate.issuer.text string    
certificate.fields.tbsCertificate.issuerUniqueID string, or null    
certificate.fields.tbsCertificate.serialNumber object    
certificate.fields.tbsCertificate.serialNumber.decimal string    
certificate.fields.tbsCertificate.serialNumber.hex string    
certificate.fields.tbsCertificate.serialNumber.octets number    
certificate.fields.tbsCertificate.signature object    
certificate.fields.tbsCertificate.signature.name string, or null    
certificate.fields.tbsCertificate.signature.oid string    
certificate.fields.tbsCertificate.signature.parameters string, or null    
certificate.fields.tbsCertificate.subject object    
certificate.fields.tbsCertificate.subject.attributes list    
certificate.fields.tbsCertificate.subject.attributes[].label string    
certificate.fields.tbsCertificate.subject.attributes[].oid string    
certificate.fields.tbsCertificate.subject.attributes[].short string    
certificate.fields.tbsCertificate.subject.attributes[].value string    
certificate.fields.tbsCertificate.subject.text string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo object    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm object    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.name string, or null    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.oid string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.parameters string, or null    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.description string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.key object    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.modulusBits integer    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.namedCurve string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.publicExponent string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.type string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.publicKeyHex string    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.publicKeyOctets integer    
certificate.fields.tbsCertificate.subjectPublicKeyInfo.spkiSha256 string    
certificate.fields.tbsCertificate.subjectUniqueID string, or null    
certificate.fields.tbsCertificate.validity object    
certificate.fields.tbsCertificate.validity.notAfter object    
certificate.fields.tbsCertificate.validity.notAfter.iso string    
certificate.fields.tbsCertificate.validity.notAfter.type string    
certificate.fields.tbsCertificate.validity.notBefore object    
certificate.fields.tbsCertificate.validity.notBefore.iso string    
certificate.fields.tbsCertificate.validity.notBefore.type string    
certificate.fields.tbsCertificate.version object    
certificate.fields.tbsCertificate.version.encoded integer    
certificate.fields.tbsCertificate.version.value integer    
certificate.fingerprint string    
certificate.fingerprints object    
certificate.fingerprints.sha1 string    
certificate.fingerprints.sha256 string    
certificate.pem string    
certificate.summary object    
certificate.summary.ca boolean    
certificate.summary.daysRemaining integer    
certificate.summary.expired boolean    
certificate.summary.extensionCount integer    
certificate.summary.issuer string    
certificate.summary.notAfter string    
certificate.summary.notBefore string    
certificate.summary.notYetValid boolean    
certificate.summary.publicKey string    
certificate.summary.selfIssued boolean    
certificate.summary.serialHex string    
certificate.summary.signatureAlgorithm string    
certificate.summary.subject string    
certificates list    
certificates[].appearances list    
certificates[].appearances[].label string    
certificates[].appearances[].where string    
certificates[].fingerprint string    
certificates[].issuer string    
certificates[].notAfter string    
certificates[].selfIssued boolean    
certificates[].subject string    
chain list    
chain[].anchor string, or null    
chain[].certificate object    
chain[].certificate.fields object    
chain[].certificate.fields.signatureAlgorithm object    
chain[].certificate.fields.signatureAlgorithm.name string, or null    
chain[].certificate.fields.signatureAlgorithm.oid string    
chain[].certificate.fields.signatureAlgorithm.parameters string, or null    
chain[].certificate.fields.signatureAlgorithmsAgree boolean    
chain[].certificate.fields.signatureValue object    
chain[].certificate.fields.signatureValue.hex string    
chain[].certificate.fields.signatureValue.octets integer    
chain[].certificate.fields.tbsCertificate object    
chain[].certificate.fields.tbsCertificate.extensions list    
chain[].certificate.fields.tbsCertificate.extensions[].critical boolean    
chain[].certificate.fields.tbsCertificate.extensions[].label string    
chain[].certificate.fields.tbsCertificate.extensions[].name string    
chain[].certificate.fields.tbsCertificate.extensions[].oid string    
chain[].certificate.fields.tbsCertificate.extensions[].parseError string, or null    
chain[].certificate.fields.tbsCertificate.extensions[].text string, or null    
chain[].certificate.fields.tbsCertificate.extensions[].value any JSON   An X.509 extension’s decoded value, on a certificate that may be anybody’s: its shape is that extension’s ASN.1 module’s. An X.509 extension’s decoded value, on a certificate that may be anybody’s: its shape is that extension’s ASN.1 module’s.
chain[].certificate.fields.tbsCertificate.issuer object    
chain[].certificate.fields.tbsCertificate.issuer.attributes list    
chain[].certificate.fields.tbsCertificate.issuer.attributes[].label object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.issuer.attributes[].oid object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.issuer.attributes[].short object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.issuer.attributes[].value object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.issuer.text string    
chain[].certificate.fields.tbsCertificate.issuerUniqueID string, or null    
chain[].certificate.fields.tbsCertificate.serialNumber object    
chain[].certificate.fields.tbsCertificate.serialNumber.decimal string    
chain[].certificate.fields.tbsCertificate.serialNumber.hex string    
chain[].certificate.fields.tbsCertificate.serialNumber.octets number    
chain[].certificate.fields.tbsCertificate.signature object    
chain[].certificate.fields.tbsCertificate.signature.name string, or null    
chain[].certificate.fields.tbsCertificate.signature.oid string    
chain[].certificate.fields.tbsCertificate.signature.parameters string, or null    
chain[].certificate.fields.tbsCertificate.subject object    
chain[].certificate.fields.tbsCertificate.subject.attributes list    
chain[].certificate.fields.tbsCertificate.subject.attributes[].label object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.subject.attributes[].oid object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.subject.attributes[].short object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.subject.attributes[].value object   Nested deeper than this page draws.
chain[].certificate.fields.tbsCertificate.subject.text string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo object    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm object    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.name string, or null    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.oid string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.algorithm.parameters string, or null    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.description string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.key object    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.modulusBits integer    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.namedCurve string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.publicExponent string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.key.type string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.publicKeyHex string    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.publicKeyOctets integer    
chain[].certificate.fields.tbsCertificate.subjectPublicKeyInfo.spkiSha256 string    
chain[].certificate.fields.tbsCertificate.subjectUniqueID string, or null    
chain[].certificate.fields.tbsCertificate.validity object    
chain[].certificate.fields.tbsCertificate.validity.notAfter object    
chain[].certificate.fields.tbsCertificate.validity.notAfter.iso string    
chain[].certificate.fields.tbsCertificate.validity.notAfter.type string    
chain[].certificate.fields.tbsCertificate.validity.notBefore object    
chain[].certificate.fields.tbsCertificate.validity.notBefore.iso string    
chain[].certificate.fields.tbsCertificate.validity.notBefore.type string    
chain[].certificate.fields.tbsCertificate.version object    
chain[].certificate.fields.tbsCertificate.version.encoded integer    
chain[].certificate.fields.tbsCertificate.version.value integer    
chain[].certificate.fingerprint string    
chain[].certificate.fingerprints object    
chain[].certificate.fingerprints.sha1 string    
chain[].certificate.fingerprints.sha256 string    
chain[].certificate.pem string    
chain[].certificate.summary object    
chain[].certificate.summary.ca boolean    
chain[].certificate.summary.daysRemaining integer    
chain[].certificate.summary.expired boolean    
chain[].certificate.summary.extensionCount integer    
chain[].certificate.summary.issuer string    
chain[].certificate.summary.notAfter string    
chain[].certificate.summary.notBefore string    
chain[].certificate.summary.notYetValid boolean    
chain[].certificate.summary.publicKey string    
chain[].certificate.summary.selfIssued boolean    
chain[].certificate.summary.serialHex string    
chain[].certificate.summary.signatureAlgorithm string    
chain[].certificate.summary.subject string    
chain[].expired boolean    
chain[].fingerprint string    
chain[].issuer string    
chain[].issuerMayCertify boolean, or null    
chain[].notYetValid boolean    
chain[].position integer    
chain[].role string    
chain[].signatureValid boolean, or null    
chain[].signedBy string, or null    
chain[].subject string    
chainReason string, or null    
chainStatus string    
chainTrusted boolean    
fingerprint string    
firstRow integer    
lastRow integer    
matched integer    
ok boolean    
page integer    
pages integer    
perPage integer    
pqc object    
pqc.algorithm string    
pqc.family string    
pqc.kind string    
pqc.label string    
pqc.standard string    
realm string    
total integer    

400: The answer.

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

GET /admin-api/pki

getPki

The certificate authority this trust realm holds, and what has been issued from it

Everything /admin/pki draws: the three CA tiers with their subjects, serials, validity, key and signature algorithms, thumbprints and CERTIFICATES; the key and signature algorithms a build may ask for; the two assertion PROFILES a key pair may be issued for, with the attributes each one writes; and every application in this realm that holds an issued key pair or declares an assertion issuer — ONE ROW PER APPLICATION AND PER PROFILE, so an application holding both an RFC 7523 and an RFC 7522 key pair appears twice. A single row with a pair of columns was the first shape of this and was wrong for a reason worth keeping: every fact on it — the key handle, the expiry, the declared issuer, whether there is a key pair to take off — is per profile.

NO PRIVATE KEY IS EVER IN THIS REPLY. common/pki.js drops every one of them on the way out, so a caller here could not leak the Root’s key by forgetting. The CERTIFICATES are in full, because a certificate is the half of a key pair that is meant to be handed around and the Root is the one thing a relying party has to be given out of band. An application’s own private key is on its directory entry as oauthAssertionPrivateKey, sealed under the same key-encryption key as the hierarchy wherever that key outlives the process, and opened for a caller that holds a credential.

IT IS PER REALM. A trust realm is a logical identity service with its own signing key and its own applications, so a CA shared across realms would be one authority vouching for several services. Reach this under a realm prefix for that realm’s hierarchy.

AND SO IS tree, SINCE 2026-09-11 — IT NARROWED AND THIS IS THE RECORD OF IT. It carried the Root, the process branch and EVERY REALM’S Intermediate for a day; it now carries the Root, the process branch (TLS and SPIFFE, which certify sockets every realm answers on) and the Intermediate of the realm THIS REQUEST WAS REACHED IN, with its Issuing CAs. revocation narrowed with it, so a Revoke here can only name an authority this realm is under. Reach the resource under another realm’s prefix for that realm’s branch — which is the same answer the console gives, because this reply and that page are one function.

REVOCATION IS PUBLISHED AND NEVER CONSULTED, SINCE 2026-09-11. Every authority signs a CRL (/pki/crl/{scope}/{ca}) and answers OCSP (/pki/ocsp/{scope}/{ca}); revocation in the reply is the REGISTER — one entry per authority with what it issued, what is on its list, and its addresses over http and ldap — and revocation-certificate below puts a serial on one. What this service does NOT do is consult a list, its own included, so a certificate revoked here still authenticates here. AND revoke BELOW IS A DIFFERENT ACT WITH THE SAME WORD IN IT: it takes a key pair off an application and puts nothing on any list. revocationNote and residency are the durable statement of what each means.

Mirrors GET /admin/pki on the admin console.

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

Scope: admin:read.

Parameters

Name In Type Required What it is
per query integer   Rows per page, SHARED by every paged list in the reply: five by default and at most five.
issuedPage query integer   Which page of issued to return, answered by issuedPaging. The Applications table on /admin/pki, five rows a page. issued itself is the WHOLE list whatever page is asked for; issuedPaging says which rows the page drew.
personsPage query integer   Which page of persons to return, answered by personsPaging. The People table on /admin/pki, paged by PERSON — a person holding both profiles is one member of persons and two rows on the page. persons is the WHOLE list; personsPaging says which people the page drew.
issuedq query string   Narrows the Applications table before it is paged: a case-insensitive substring of the identifier, the profile, the key handle or a declared issuer. issuedPaging.total is then the count that matched, and issuedSearch echoes it.
rows query one of all, shown   shown reads each key pair’s certificate — its pqc member — for the rows of the requested pages only, which is what the console draws; the other rows carry no pqc. all, the default, reads every row’s.
personsq query string   Narrows the People table before it is paged: a case-insensitive substring of the username, either key handle or an issuer either profile asserts as. personsPaging.total is then the count that matched, and personsSearch echoes it.
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 hierarchy, the algorithm vocabularies, the two assertion profiles, one row per application per profile for those holding an issued key pair, with issuedPaging and personsPaging beside the two lists, and each authority’s revocation lists as pages (#370): issued and revokedNotIssued on each authority are one page each, five rows at most, on the query parameters ca-<scope segment>-<ca>-issuedPage and …-orphansPage, each narrowed first by ca-<scope segment>-<ca>-issuedq and …-orphansq (a case-insensitive substring of the serial, the subject, the name or reason), with issuedPaging, orphansPaging (whose total is the count that matched), issuedSearch, orphansSearch, issuedTotal, revokedTotal and revokedNotIssuedTotal beside them.

Member Type Required What it is
actions list    
actions[] string    
chain object    
chain.altKeyAlg string, or null    
chain.country string, or null    
chain.createdAt string, or number, or null    
chain.issuedCount integer    
chain.keyAlg string    
chain.organisation string, or null    
chain.persisted boolean    
chain.realm string, or null    
chain.signatureAlg string    
chain.tiers list    
chain.tiers[].altKeyAlg string, or null    
chain.tiers[].altSignatureAlg string, or null    
chain.tiers[].certificatePem string    
chain.tiers[].expired boolean    
chain.tiers[].imported boolean    
chain.tiers[].keyAlg string    
chain.tiers[].label string    
chain.tiers[].notAfter string    
chain.tiers[].notBefore string    
chain.tiers[].pqc object    
chain.tiers[].pqc.algorithm string    
chain.tiers[].pqc.family string    
chain.tiers[].pqc.kind string    
chain.tiers[].pqc.label string    
chain.tiers[].pqc.standard string    
chain.tiers[].scope string, or null    
chain.tiers[].serialHex string    
chain.tiers[].signatureAlg string    
chain.tiers[].subject string    
chain.tiers[].thumbprint string    
chain.tiers[].tier string    
chain.tiers[].useCase string, or null    
chain.tiers[].what string    
encoder string    
issued list    
issued[].assertionIssuers list    
issued[].assertionIssuers[] string    
issued[].expiresAt string    
issued[].handle string    
issued[].handleLabel string    
issued[].hasKeyPair boolean    
issued[].identifier string    
issued[].name string, or null    
issued[].pqc object    
issued[].pqc.algorithm string    
issued[].pqc.family string    
issued[].pqc.kind string    
issued[].pqc.label string    
issued[].pqc.standard string    
issued[].privateKeyHeld boolean    
issued[].purpose string    
issued[].purposeLabel string    
issued[].registeredOwnKeys boolean    
issued[].source string    
issuedPaging object    
issuedPaging.firstRow integer    
issuedPaging.lastRow integer    
issuedPaging.noun string    
issuedPaging.page integer    
issuedPaging.pages integer    
issuedPaging.param string    
issuedPaging.perPage integer    
issuedPaging.total integer    
issuedSearch string, or null    
issuedShown list    
issuedShown[] integer    
keyAlgorithms list    
keyAlgorithms[].family string    
keyAlgorithms[].id string    
keyAlgorithms[].kind string    
keyAlgorithms[].label string    
keyAlgorithms[].signs boolean    
keyAlgorithms[].slow boolean    
pageDefaults object    
pageDefaults.alternativeKeyAlgorithm string, or null    
pageDefaults.keyAlgorithm string    
pageDefaults.leafLifetimeDays number    
pageDefaults.organisation string    
personAttributes list    
personAttributes[] string    
personIssuerAttribute string    
personRevocationReasons list    
personRevocationReasons[] string    
personSigningKeyMax number    
persons list    
persons[].jwt object    
persons[].jwt.declared boolean    
persons[].jwt.declaredIssuers list    
persons[].jwt.declaredIssuers[] string    
persons[].jwt.hasKeyPair boolean    
persons[].jwt.issuers list    
persons[].jwt.issuers[] string    
persons[].jwt.keys list    
persons[].jwt.keys[].caId string, or null    
persons[].jwt.keys[].certificatePem string    
persons[].jwt.keys[].chainPem string    
persons[].jwt.keys[].createdAt string, or number, or null    
persons[].jwt.keys[].expiresAt string    
persons[].jwt.keys[].id string    
persons[].jwt.keys[].issuer string    
persons[].jwt.keys[].jwk object    
persons[].jwt.keys[].jwk.alg string    
persons[].jwt.keys[].jwk.crv string    
persons[].jwt.keys[].jwk.e string    
persons[].jwt.keys[].jwk.ek string    
persons[].jwt.keys[].jwk.ext boolean    
persons[].jwt.keys[].jwk.key_ops list    
persons[].jwt.keys[].jwk.key_ops[] string    
persons[].jwt.keys[].jwk.kid string    
persons[].jwt.keys[].jwk.kty string    
persons[].jwt.keys[].jwk.n string    
persons[].jwt.keys[].jwk.pub string    
persons[].jwt.keys[].jwk.use string    
persons[].jwt.keys[].jwk.x string    
persons[].jwt.keys[].jwk.x5c list    
persons[].jwt.keys[].jwk.x5c[] string    
persons[].jwt.keys[].jwk.x5t string    
persons[].jwt.keys[].jwk.x5t#S256 string    
persons[].jwt.keys[].jwk.x5u string    
persons[].jwt.keys[].jwk.y string    
persons[].jwt.keys[].jwsAlg string    
persons[].jwt.keys[].keyAlg string    
persons[].jwt.keys[].kid string    
persons[].jwt.keys[].label string    
persons[].jwt.keys[].notAfter string    
persons[].jwt.keys[].notBefore string    
persons[].jwt.keys[].pqc object    
persons[].jwt.keys[].pqc.algorithm string    
persons[].jwt.keys[].pqc.family string    
persons[].jwt.keys[].pqc.kind string    
persons[].jwt.keys[].pqc.label string    
persons[].jwt.keys[].pqc.standard string    
persons[].jwt.keys[].privateKeyHeld boolean    
persons[].jwt.keys[].reason string, or null    
persons[].jwt.keys[].revokedAt string, or number, or null    
persons[].jwt.keys[].serialHex string    
persons[].jwt.keys[].source string    
persons[].jwt.keys[].state string    
persons[].jwt.keys[].subject string    
persons[].jwt.keys[].thumbprint string    
persons[].jwt.keys[].withdrawnAt string    
persons[].jwt.keys[].withdrawnReason string    
persons[].saml object    
persons[].saml.declared boolean    
persons[].saml.declaredIssuers list    
persons[].saml.declaredIssuers[] string    
persons[].saml.hasKeyPair boolean    
persons[].saml.issuers list    
persons[].saml.issuers[] string    
persons[].saml.keys list    
persons[].saml.keys[].caId string, or null    
persons[].saml.keys[].certificatePem string    
persons[].saml.keys[].chainPem string    
persons[].saml.keys[].createdAt string, or number, or null    
persons[].saml.keys[].expiresAt string    
persons[].saml.keys[].id string    
persons[].saml.keys[].issuer string    
persons[].saml.keys[].jwk object    
persons[].saml.keys[].jwk.alg string    
persons[].saml.keys[].jwk.crv string    
persons[].saml.keys[].jwk.e string    
persons[].saml.keys[].jwk.ek string    
persons[].saml.keys[].jwk.ext boolean    
persons[].saml.keys[].jwk.key_ops list    
persons[].saml.keys[].jwk.key_ops[] string    
persons[].saml.keys[].jwk.kid string    
persons[].saml.keys[].jwk.kty string    
persons[].saml.keys[].jwk.n string    
persons[].saml.keys[].jwk.pub string    
persons[].saml.keys[].jwk.use string    
persons[].saml.keys[].jwk.x string    
persons[].saml.keys[].jwk.x5c list    
persons[].saml.keys[].jwk.x5c[] string    
persons[].saml.keys[].jwk.x5t string    
persons[].saml.keys[].jwk.x5t#S256 string    
persons[].saml.keys[].jwk.x5u string    
persons[].saml.keys[].jwk.y string    
persons[].saml.keys[].jwsAlg string    
persons[].saml.keys[].keyAlg string    
persons[].saml.keys[].kid string    
persons[].saml.keys[].label string    
persons[].saml.keys[].notAfter string    
persons[].saml.keys[].notBefore string    
persons[].saml.keys[].pqc object    
persons[].saml.keys[].pqc.algorithm string    
persons[].saml.keys[].pqc.family string    
persons[].saml.keys[].pqc.kind string    
persons[].saml.keys[].pqc.label string    
persons[].saml.keys[].pqc.standard string    
persons[].saml.keys[].privateKeyHeld boolean    
persons[].saml.keys[].reason string, or null    
persons[].saml.keys[].revokedAt string, or number, or null    
persons[].saml.keys[].serialHex string    
persons[].saml.keys[].source string    
persons[].saml.keys[].state string    
persons[].saml.keys[].subject string    
persons[].saml.keys[].thumbprint string    
persons[].saml.keys[].withdrawnAt string    
persons[].saml.keys[].withdrawnReason string    
persons[].username string    
personsPaging object    
personsPaging.firstRow integer    
personsPaging.lastRow integer    
personsPaging.noun string    
personsPaging.page integer    
personsPaging.pages integer    
personsPaging.param string    
personsPaging.perPage integer    
personsPaging.total integer    
personsSearch string, or null    
personsShown list    
personsShown[] integer    
personsStorable boolean    
pinnedSigners object    
pinnedSigners.keys list    
pinnedSigners.keys[].activatesAt string    
pinnedSigners.keys[].alg string    
pinnedSigners.keys[].certificatePem string    
pinnedSigners.keys[].chainPem list    
pinnedSigners.keys[].chainPem[] string    
pinnedSigners.keys[].crv string    
pinnedSigners.keys[].daysLeft integer    
pinnedSigners.keys[].expired boolean    
pinnedSigners.keys[].expiringSoon boolean    
pinnedSigners.keys[].kid string    
pinnedSigners.keys[].kind string    
pinnedSigners.keys[].notAfter string    
pinnedSigners.keys[].operatorCertificate boolean    
pinnedSigners.keys[].pinnedAt string    
pinnedSigners.keys[].publicJwk object    
pinnedSigners.keys[].publicJwk.alg string    
pinnedSigners.keys[].publicJwk.crv string    
pinnedSigners.keys[].publicJwk.e string    
pinnedSigners.keys[].publicJwk.ek string    
pinnedSigners.keys[].publicJwk.ext boolean    
pinnedSigners.keys[].publicJwk.key_ops list    
pinnedSigners.keys[].publicJwk.key_ops[] string    
pinnedSigners.keys[].publicJwk.kid string    
pinnedSigners.keys[].publicJwk.kty string    
pinnedSigners.keys[].publicJwk.n string    
pinnedSigners.keys[].publicJwk.pub string    
pinnedSigners.keys[].publicJwk.use string    
pinnedSigners.keys[].publicJwk.x string    
pinnedSigners.keys[].publicJwk.x5c list    
pinnedSigners.keys[].publicJwk.x5c[] string    
pinnedSigners.keys[].publicJwk.x5t string    
pinnedSigners.keys[].publicJwk.x5t#S256 string    
pinnedSigners.keys[].publicJwk.x5u string    
pinnedSigners.keys[].publicJwk.y string    
pinnedSigners.keys[].publicKeyPem string    
pinnedSigners.keys[].retiredAt string    
pinnedSigners.keys[].retiredUntil string    
pinnedSigners.keys[].role string    
pinnedSigners.keys[].serialHex string    
pinnedSigners.keys[].slot string    
pinnedSigners.keys[].subject string    
pinnedSigners.keys[].supersedesUntil string    
pinnedSigners.keys[].thumbprint string    
pinnedSigners.keys[].unit string    
pinnedSigners.keys[].useCase string    
pinnedSigners.leadMinutes number    
pinnedSigners.on boolean    
pinnedSigners.warningDays number    
protocolEndpoints list    
protocolEndpoints[].listening boolean    
protocolEndpoints[].methods list, or string    
protocolEndpoints[].methods[] string    
protocolEndpoints[].name string    
protocolEndpoints[].registered boolean    
protocolEndpoints[].route string    
protocolEndpoints[].transport string    
protocolEndpoints[].url string    
purposes list    
purposes[].attributes list    
purposes[].attributes[] string    
purposes[].id string    
purposes[].issuerAttribute string    
purposes[].label string    
purposes[].what string    
realm string    
residency string    
revocation object    
revocation.authorities list    
revocation.authorities[].ca string    
revocation.authorities[].caIssuers string, or null    
revocation.authorities[].crl object    
revocation.authorities[].crl.http string    
revocation.authorities[].crl.ldap string, or null    
revocation.authorities[].directoryDn string, or null    
revocation.authorities[].issued list    
revocation.authorities[].issued[].expired boolean    
revocation.authorities[].issued[].held boolean    
revocation.authorities[].issued[].kind string    
revocation.authorities[].issued[].label string    
revocation.authorities[].issued[].notAfter string    
revocation.authorities[].issued[].revoked boolean    
revocation.authorities[].issued[].revokedAt string, or number, or null    
revocation.authorities[].issued[].revokedReason string, or null    
revocation.authorities[].issued[].serialHex string    
revocation.authorities[].issued[].subject string    
revocation.authorities[].issuedPaging object    
revocation.authorities[].issuedPaging.firstRow integer    
revocation.authorities[].issuedPaging.lastRow integer    
revocation.authorities[].issuedPaging.noun string    
revocation.authorities[].issuedPaging.page integer    
revocation.authorities[].issuedPaging.pages integer    
revocation.authorities[].issuedPaging.param string    
revocation.authorities[].issuedPaging.perPage integer    
revocation.authorities[].issuedPaging.total integer    
revocation.authorities[].issuedSearch string, or null    
revocation.authorities[].issuedTotal integer    
revocation.authorities[].label string    
revocation.authorities[].listName string    
revocation.authorities[].notAfter string    
revocation.authorities[].ocsp string, or null    
revocation.authorities[].orphansPaging object    
revocation.authorities[].orphansPaging.firstRow integer    
revocation.authorities[].orphansPaging.lastRow integer    
revocation.authorities[].orphansPaging.noun string    
revocation.authorities[].orphansPaging.page integer    
revocation.authorities[].orphansPaging.pages integer    
revocation.authorities[].orphansPaging.param string    
revocation.authorities[].orphansPaging.perPage integer    
revocation.authorities[].orphansPaging.total integer    
revocation.authorities[].orphansSearch string, or null    
revocation.authorities[].revoked list    
revocation.authorities[].revoked[].note string    
revocation.authorities[].revoked[].reason string    
revocation.authorities[].revoked[].reasonCode integer    
revocation.authorities[].revoked[].reasonWhat string    
revocation.authorities[].revoked[].revokedAt string, or number, or null    
revocation.authorities[].revoked[].serialHex string    
revocation.authorities[].revoked[].subject string    
revocation.authorities[].revokedNotIssued list    
revocation.authorities[].revokedNotIssued[].note string    
revocation.authorities[].revokedNotIssued[].reason string    
revocation.authorities[].revokedNotIssued[].reasonCode integer    
revocation.authorities[].revokedNotIssued[].reasonWhat string    
revocation.authorities[].revokedNotIssued[].revokedAt string, or number, or null    
revocation.authorities[].revokedNotIssued[].serialHex string    
revocation.authorities[].revokedNotIssued[].subject string    
revocation.authorities[].revokedNotIssuedTotal integer    
revocation.authorities[].revokedTotal integer    
revocation.authorities[].scope string    
revocation.authorities[].scopeSegment string    
revocation.authorities[].subject string    
revocation.crlLifetimeMinutes number    
revocation.publishedToDirectory boolean    
revocation.reasons list    
revocation.reasons[].code integer    
revocation.reasons[].id string    
revocation.reasons[].what string    
revocation.totalRevoked integer    
revocationNote string    
serviceScope string    
settings object    
settings.context object    
settings.context.configFile string, or null    
settings.context.defaultsFile string, or null    
settings.context.inRealm boolean    
settings.context.persistenceMode string    
settings.context.persistsAppconfig boolean    
settings.context.persistsRealms boolean    
settings.context.realmId string    
settings.editableCount integer    
settings.groups list    
settings.groups[].group string    
settings.groups[].settings list    
settings.groups[].settings[].appconfigPath string    
settings.groups[].settings[].csvValueNotes map    
settings.groups[].settings[].csvValueNotes.{key} string    
settings.groups[].settings[].csvValues list    
settings.groups[].settings[].csvValues[] string, or number, or boolean, or null    
settings.groups[].settings[].default list, or string, or number, or boolean, or null    
settings.groups[].settings[].default[] string, or number, or boolean, or null    
settings.groups[].settings[].description string    
settings.groups[].settings[].editRefusal string    
settings.groups[].settings[].editable boolean    
settings.groups[].settings[].enumValues list    
settings.groups[].settings[].enumValues[] string, or number, or boolean, or null    
settings.groups[].settings[].env list, or string    
settings.groups[].settings[].env[] string    
settings.groups[].settings[].group string    
settings.groups[].settings[].key string    
settings.groups[].settings[].label string    
settings.groups[].settings[].legacyEnv list, or string    
settings.groups[].settings[].legacyEnv[] string    
settings.groups[].settings[].masked boolean    
settings.groups[].settings[].max number    
settings.groups[].settings[].min number    
settings.groups[].settings[].ordered boolean    
settings.groups[].settings[].overridden boolean    
settings.groups[].settings[].realmSettable boolean    
settings.groups[].settings[].restartReason string    
settings.groups[].settings[].selectAll object    
settings.groups[].settings[].selectAll.aloneWhileOn list    
settings.groups[].settings[].selectAll.aloneWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.aloneWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn list    
settings.groups[].settings[].selectAll.onlyWhileOn[].canBeOn object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].on object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].setting object   Nested deeper than this page draws.
settings.groups[].settings[].selectAll.onlyWhileOn[].values object   Nested deeper than this page draws.
settings.groups[].settings[].source string    
settings.groups[].settings[].step number    
settings.groups[].settings[].text string, or null    
settings.groups[].settings[].type string    
settings.groups[].settings[].value list, or string, or number, or boolean, or null    
settings.groups[].settings[].value[] string, or number, or boolean, or null    
settings.overridden list    
settings.overridden[] string    
settings.page string    
settings.setWith string    
settings.settingCount integer    
settings.sharedWith map    
settings.sharedWith.{key} list    
settings.sharedWith.{key}[].label string    
settings.sharedWith.{key}[].path string    
signatureAlgorithms list    
signatureAlgorithms[].id string    
signatureAlgorithms[].kind string, or null    
signatureAlgorithms[].label string    
signatureAlgorithms[].weak boolean    
subjectKinds list    
subjectKinds[].id string    
subjectKinds[].label string    
subjectKinds[].what string    
tierLabels list    
tierLabels[].id string    
tierLabels[].label string    
tiers list    
tiers[].id string    
tiers[].keyUsage list    
tiers[].keyUsage[] string    
tiers[].label string    
tiers[].pathLen integer, or null    
tiers[].profile string    
tiers[].what string    
tiers[].years number    
tree object    
tree.organisation string    
tree.persisted boolean    
tree.root object    
tree.root.altKeyAlg string, or null    
tree.root.altSignatureAlg string, or null    
tree.root.certificatePem string    
tree.root.expired boolean    
tree.root.imported boolean    
tree.root.keyAlg string    
tree.root.label string    
tree.root.notAfter string    
tree.root.notBefore string    
tree.root.pqc object    
tree.root.pqc.algorithm string    
tree.root.pqc.family string    
tree.root.pqc.kind string    
tree.root.pqc.label string    
tree.root.pqc.standard string    
tree.root.scope string, or null    
tree.root.serialHex string    
tree.root.signatureAlg string    
tree.root.subject string    
tree.root.thumbprint string    
tree.root.tier string    
tree.root.useCase string, or null    
tree.root.what string    
tree.rootBuilt boolean    
tree.scopes list    
tree.scopes[].altKeyAlg string, or null    
tree.scopes[].built boolean    
tree.scopes[].country string    
tree.scopes[].intermediate object    
tree.scopes[].intermediate.altKeyAlg string, or null    
tree.scopes[].intermediate.altSignatureAlg string, or null    
tree.scopes[].intermediate.certificatePem string    
tree.scopes[].intermediate.expired boolean    
tree.scopes[].intermediate.imported boolean    
tree.scopes[].intermediate.keyAlg string    
tree.scopes[].intermediate.label string    
tree.scopes[].intermediate.notAfter string    
tree.scopes[].intermediate.notBefore string    
tree.scopes[].intermediate.pqc object    
tree.scopes[].intermediate.pqc.algorithm string    
tree.scopes[].intermediate.pqc.family string    
tree.scopes[].intermediate.pqc.kind string    
tree.scopes[].intermediate.pqc.label string    
tree.scopes[].intermediate.pqc.standard string    
tree.scopes[].intermediate.scope string, or null    
tree.scopes[].intermediate.serialHex string    
tree.scopes[].intermediate.signatureAlg string    
tree.scopes[].intermediate.subject string    
tree.scopes[].intermediate.thumbprint string    
tree.scopes[].intermediate.tier string    
tree.scopes[].intermediate.useCase string, or null    
tree.scopes[].intermediate.what string    
tree.scopes[].issuing list    
tree.scopes[].issuing[].built boolean    
tree.scopes[].issuing[].ca object    
tree.scopes[].issuing[].ca.altKeyAlg string, or null    
tree.scopes[].issuing[].ca.altSignatureAlg string, or null    
tree.scopes[].issuing[].ca.certificatePem string    
tree.scopes[].issuing[].ca.expired boolean    
tree.scopes[].issuing[].ca.imported boolean    
tree.scopes[].issuing[].ca.keyAlg string    
tree.scopes[].issuing[].ca.label string    
tree.scopes[].issuing[].ca.notAfter string    
tree.scopes[].issuing[].ca.notBefore string    
tree.scopes[].issuing[].ca.pqc object    
tree.scopes[].issuing[].ca.pqc.algorithm string    
tree.scopes[].issuing[].ca.pqc.family string    
tree.scopes[].issuing[].ca.pqc.kind string    
tree.scopes[].issuing[].ca.pqc.label string    
tree.scopes[].issuing[].ca.pqc.standard string    
tree.scopes[].issuing[].ca.scope string, or null    
tree.scopes[].issuing[].ca.serialHex string    
tree.scopes[].issuing[].ca.signatureAlg string    
tree.scopes[].issuing[].ca.subject string    
tree.scopes[].issuing[].ca.thumbprint string    
tree.scopes[].issuing[].ca.tier string    
tree.scopes[].issuing[].ca.useCase string, or null    
tree.scopes[].issuing[].ca.what string    
tree.scopes[].issuing[].certified list    
tree.scopes[].issuing[].certified[].alg string    
tree.scopes[].issuing[].certified[].certificatePem string    
tree.scopes[].issuing[].certified[].chainPem list    
tree.scopes[].issuing[].certified[].chainPem[] object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].createdAt string, or number, or null    
tree.scopes[].issuing[].certified[].expired boolean    
tree.scopes[].issuing[].certified[].keyAlg string    
tree.scopes[].issuing[].certified[].label string, or null    
tree.scopes[].issuing[].certified[].notAfter string    
tree.scopes[].issuing[].certified[].notBefore string    
tree.scopes[].issuing[].certified[].pinned boolean    
tree.scopes[].issuing[].certified[].pqc object    
tree.scopes[].issuing[].certified[].pqc.algorithm object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].pqc.family object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].pqc.kind object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].pqc.label object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].pqc.standard object   Nested deeper than this page draws.
tree.scopes[].issuing[].certified[].serialHex string    
tree.scopes[].issuing[].certified[].signatureAlg string    
tree.scopes[].issuing[].certified[].slot string    
tree.scopes[].issuing[].certified[].subject string    
tree.scopes[].issuing[].certified[].thumbprint string    
tree.scopes[].issuing[].certified[].useCase string    
tree.scopes[].issuing[].id string    
tree.scopes[].issuing[].label string    
tree.scopes[].issuing[].what string    
tree.scopes[].keyAlg string    
tree.scopes[].kind string    
tree.scopes[].label string    
tree.scopes[].organisation string    
tree.scopes[].scope string    
tree.scopes[].signatureAlg string    
tree.useCases list    
tree.useCases[].id string    
tree.useCases[].label string    
tree.useCases[].scope string    
tree.useCases[].what string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

400: The answer.

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

POST /admin-api/pki/build

buildPkiChain

Build this realm’s certificate authority — all three tiers

Root CA, Intermediate CA and Issuing CA, generated and signed in one act.

ALL THREE OR NONE, and that is not laziness. A trust chain is only worth anything whole: an Issuing CA with no Intermediate above it is a two-tier chain wearing a three-tier name, and a half-built hierarchy is exactly the state in which somebody issues a certificate that verifies here and nowhere else. A failure at any tier stores nothing.

CALLING IT AGAIN REPLACES WHAT IS THERE, and everything issued from the old hierarchy chains to nothing the moment it does. This service keeps no copy of what it issued, so none of it can be listed — the key pairs are on the application entries and go on SIGNING; what stops is this service being able to see that it issued them.

WHERE IT SURVIVES A RESTART depends on the mode. In product mode the hierarchy is written to sts_keys, sealed under the same key-encryption key as the signing keys. In development — the default — it lives exactly as long as the process, which is the rule the signing key follows and for the same reason.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
altKeyAlg one of ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, none   The post-quantum key every authority built here holds beside its classical one (ITU-T X.509 clause 9.8, #68): one of alternativeKeyAlgorithms on GET /admin-api/pki, or none for a classical-only authority. Defaults to pki.alternativeKeyAlgorithm.
cn_intermediate string   The Intermediate CA’s common name.
cn_issuing string   The Issuing CA’s common name.
cn_root string   The Root CA’s common name.
country one of AD, AE, AF, AG, AI, AL, AM, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW   The C=, two letters, optional. It is encoded as a PrintableString, which is interoperability rather than taste — several validators refuse a UTF8String country and report it as a signature problem.
keyAlg one of rsa-2048, rsa-3072, rsa-4096, ec-p256, ec-p384, ec-p521, ed25519, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, mldsa44-rsa2048-pss-sha256, mldsa44-rsa2048-pkcs15-sha256, mldsa44-ed25519-sha512, mldsa44-ecdsa-p256-sha256, mldsa65-rsa3072-pss-sha512, mldsa65-rsa3072-pkcs15-sha512, mldsa65-rsa4096-pss-sha512, mldsa65-rsa4096-pkcs15-sha512, mldsa65-ecdsa-p256-sha512, mldsa65-ecdsa-p384-sha512, mldsa65-ed25519-sha512, mldsa87-ecdsa-p384-sha512, mldsa87-ed448-shake256, mldsa87-rsa3072-pss-sha512, mldsa87-rsa4096-pss-sha512, mldsa87-ecdsa-p521-sha512, ml-kem-512, ml-kem-768, ml-kem-1024   One of the ids in keyAlgorithms on GET /admin-api/pki: rsa-2048, rsa-3072, rsa-4096, ec-p256, ec-p384, ec-p521 or ed25519. One algorithm for all three tiers — the LEAF’s signature algorithm is decided by the Issuing CA’s key, and that is what a client library has to be able to verify. Defaults to pki.keyAlgorithm.
organisation string   The O= every tier carries, and what the tiers are named after when no common name is given. Defaults to pki.organisation.
signatureAlg one of sha256-rsa, sha384-rsa, sha512-rsa, sha256-rsapss, sha384-rsapss, sha512-rsapss, sha1-rsa, sha256-ecdsa, sha384-ecdsa, sha512-ecdsa, sha1-ecdsa, ed25519, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, mldsa44-rsa2048-pss-sha256, mldsa44-rsa2048-pkcs15-sha256, mldsa44-ed25519-sha512, mldsa44-ecdsa-p256-sha256, mldsa65-rsa3072-pss-sha512, mldsa65-rsa3072-pkcs15-sha512, mldsa65-rsa4096-pss-sha512, mldsa65-rsa4096-pkcs15-sha512, mldsa65-ecdsa-p256-sha512, mldsa65-ecdsa-p384-sha512, mldsa65-ed25519-sha512, mldsa87-ecdsa-p384-sha512, mldsa87-ed448-shake256, mldsa87-rsa3072-pss-sha512, mldsa87-rsa4096-pss-sha512, mldsa87-ecdsa-p521-sha512   One of the ids in signatureAlgorithms. OMIT IT for “the right one for the key algorithm”, which is almost always what is wanted: an EC key’s digest is decided by its CURVE, so naming one here can hand a P-521 key SHA-256 — legal, verifying, and nobody’s intention. A pair whose families disagree is refused with the list beside it.
years_intermediate integer   Ten by default.
years_issuing integer   Five by default.
years_root integer   How long the Root is valid. Defaults to the certificate profile’s own twenty years.

200: The hierarchy that was built, without its private keys.

Member Type Required What it is
chain object    
chain.altKeyAlg string, or null    
chain.country string, or null    
chain.createdAt string, or number, or null    
chain.issuedCount integer    
chain.keyAlg string    
chain.organisation string, or null    
chain.persisted boolean    
chain.realm string, or null    
chain.signatureAlg string    
chain.tiers list    
chain.tiers[].altKeyAlg string, or null    
chain.tiers[].altSignatureAlg string, or null    
chain.tiers[].certificatePem string    
chain.tiers[].expired boolean    
chain.tiers[].imported boolean    
chain.tiers[].keyAlg string    
chain.tiers[].label string    
chain.tiers[].notAfter string    
chain.tiers[].notBefore string    
chain.tiers[].pqc object    
chain.tiers[].pqc.algorithm string    
chain.tiers[].pqc.family string    
chain.tiers[].pqc.kind string    
chain.tiers[].pqc.label string    
chain.tiers[].pqc.standard string    
chain.tiers[].scope string, or null    
chain.tiers[].serialHex string    
chain.tiers[].signatureAlg string    
chain.tiers[].subject string    
chain.tiers[].thumbprint string    
chain.tiers[].tier string    
chain.tiers[].useCase string, or null    
chain.tiers[].what string    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
chain object    
chain.altKeyAlg string, or null    
chain.country string, or null    
chain.createdAt string, or number, or null    
chain.issuedCount integer    
chain.keyAlg string    
chain.organisation string, or null    
chain.persisted boolean    
chain.realm string, or null    
chain.signatureAlg string    
chain.tiers list    
chain.tiers[].altKeyAlg string, or null    
chain.tiers[].altSignatureAlg string, or null    
chain.tiers[].certificatePem string    
chain.tiers[].expired boolean    
chain.tiers[].imported boolean    
chain.tiers[].keyAlg string    
chain.tiers[].label string    
chain.tiers[].notAfter string    
chain.tiers[].notBefore string    
chain.tiers[].pqc object    
chain.tiers[].pqc.algorithm string    
chain.tiers[].pqc.family string    
chain.tiers[].pqc.kind string    
chain.tiers[].pqc.label string    
chain.tiers[].pqc.standard string    
chain.tiers[].scope string, or null    
chain.tiers[].serialHex string    
chain.tiers[].signatureAlg string    
chain.tiers[].subject string    
chain.tiers[].thumbprint string    
chain.tiers[].tier string    
chain.tiers[].useCase string, or null    
chain.tiers[].what string    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/build-root

buildPkiRoot

Build or replace the Root CA for the whole service

One Root, shared by every realm and by the process branch — which is what lets an operator install ONE anchor and have it cover LDAPS 636, the main port and every token this service signs.

REPLACING IT RE-ISSUES EVERY BRANCH IN THE SAME ACT, because an Intermediate still hanging from the old Root chains to nothing — a new Root with the old branches under it is a service whose tree does not reach its own anchor, and every path check fails while the page looks right.

ANYTHING TRUSTING THE OLD ROOT STOPS TRUSTING THIS SERVICE. That is the cost of one anchor covering everything. The signing keys themselves are untouched, so nothing that verifies against the published JWKS is affected.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
altKeyAlg one of ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, none   The post-quantum key every authority built here holds beside its classical one (ITU-T X.509 clause 9.8, #68): one of alternativeKeyAlgorithms on GET /admin-api/pki, or none for a classical-only authority. Defaults to pki.alternativeKeyAlgorithm.
commonName string   The Root’s CN. Defaults to the organisation followed by “Root CA”.
keyAlg one of rsa-2048, rsa-3072, rsa-4096, ec-p256, ec-p384, ec-p521, ed25519, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, mldsa44-rsa2048-pss-sha256, mldsa44-rsa2048-pkcs15-sha256, mldsa44-ed25519-sha512, mldsa44-ecdsa-p256-sha256, mldsa65-rsa3072-pss-sha512, mldsa65-rsa3072-pkcs15-sha512, mldsa65-rsa4096-pss-sha512, mldsa65-rsa4096-pkcs15-sha512, mldsa65-ecdsa-p256-sha512, mldsa65-ecdsa-p384-sha512, mldsa65-ed25519-sha512, mldsa87-ecdsa-p384-sha512, mldsa87-ed448-shake256, mldsa87-rsa3072-pss-sha512, mldsa87-rsa4096-pss-sha512, mldsa87-ecdsa-p521-sha512, ml-kem-512, ml-kem-768, ml-kem-1024   One of the ids in keyAlgorithms. Defaults to pki.keyAlgorithm.
years integer   How long it is valid for. Defaults to the root-ca profile’s own twenty years.

200: The new Root, and how many branches were re-issued under it.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
root object    
root.altKeyAlg string, or null    
root.altSignatureAlg string, or null    
root.certificatePem string    
root.expired boolean    
root.imported boolean    
root.keyAlg string    
root.label string    
root.notAfter string    
root.notBefore string    
root.pqc object    
root.pqc.algorithm string    
root.pqc.family string    
root.pqc.kind string    
root.pqc.label string    
root.pqc.standard string    
root.scope string, or null    
root.serialHex string    
root.signatureAlg string    
root.subject string    
root.thumbprint string    
root.tier string    
root.useCase string, or null    
root.what string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
root object    
root.altKeyAlg string, or null    
root.altSignatureAlg string, or null    
root.certificatePem string    
root.expired boolean    
root.imported boolean    
root.keyAlg string    
root.label string    
root.notAfter string    
root.notBefore string    
root.pqc object    
root.pqc.algorithm string    
root.pqc.family string    
root.pqc.kind string    
root.pqc.label string    
root.pqc.standard string    
root.scope string, or null    
root.serialHex string    
root.signatureAlg string    
root.subject string    
root.thumbprint string    
root.tier string    
root.useCase string, or null    
root.what string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/build-scope

buildPkiScope

Build or rebuild one scope’s branch — its Intermediate and every Issuing CA under it

A scope is a trust realm or the process. ALL OF IT OR NONE OF IT: a branch with an Intermediate and two of its three Issuing CAs is the state in which one use case silently has no authority and its keys come out uncertified, so a failure anywhere stores nothing.

THE ROOT IS NOT TOUCHED — every other scope hangs from it — and an IMPORTED authority in this branch is left alone unless replaceImported says otherwise: somebody who pasted a corporate CA in did not press this to have it thrown away.

Everything the old authorities had certified is re-minted from the new ones in the same act.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
altKeyAlg one of ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, none   The post-quantum key every authority built here holds beside its classical one (ITU-T X.509 clause 9.8, #68): one of alternativeKeyAlgorithms on GET /admin-api/pki, or none for a classical-only authority. Defaults to pki.alternativeKeyAlgorithm.
keyAlg one of rsa-2048, rsa-3072, rsa-4096, ec-p256, ec-p384, ec-p521, ed25519, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, mldsa44-rsa2048-pss-sha256, mldsa44-rsa2048-pkcs15-sha256, mldsa44-ed25519-sha512, mldsa44-ecdsa-p256-sha256, mldsa65-rsa3072-pss-sha512, mldsa65-rsa3072-pkcs15-sha512, mldsa65-rsa4096-pss-sha512, mldsa65-rsa4096-pkcs15-sha512, mldsa65-ecdsa-p256-sha512, mldsa65-ecdsa-p384-sha512, mldsa65-ed25519-sha512, mldsa87-ecdsa-p384-sha512, mldsa87-ed448-shake256, mldsa87-rsa3072-pss-sha512, mldsa87-rsa4096-pss-sha512, mldsa87-ecdsa-p521-sha512, ml-kem-512, ml-kem-768, ml-kem-1024   The key algorithm every CA in this branch is generated with.
replaceImported boolean   Replace an imported authority too. Default false.
scope string   A realm id, *process, or omitted for the realm this request arrived in.

200: The branch, and how many certificates were re-minted under it.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/clear

clearPkiChain

Remove this realm’s certificate authority entirely

Destructive, and it says so: every certificate issued from the hierarchy chains to nothing the moment this returns, and this service keeps no copy of what it issued, so nothing here can list what broke. The key pairs stay on the application entries and go on signing; what stops is this service being able to see that it issued them.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

An empty object.

200: How many certificates had been issued from the hierarchy that was removed.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/clear-store

clearPkiObjects

Empty this realm’s object store

Every key pair and certificate the pane issued in this realm is discarded. The three-tier hierarchy is NOT touched — that is clear — and anything these keys signed is still a valid document that still chains to whatever signed IT.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

An empty object.

200: How many objects were discarded.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/export

exportPkiKeyPair

Write a key pair out as PEM, DER, a JWK set or a PKCS#12

The same export /admin/keys uses (common/crypto_impl/key_material.js), so a .p12 from here imports identically into keytool, OpenSSL, Windows and macOS.

The answer is JSON with the bytes base64’d and named, and the console’s Download button comes through here too since #446: it saves each named file as the attachment the server-rendered console sent.

IT HANDS OVER A PRIVATE KEY, so like every other such door here it needs admin:write rather than admin:read.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

Member Type Required What it is
objectId string   The object to write out. Omitted, the key pair in pki_private_key and pki_public_key is used.

200: One entry per member of files: its name, its media type and its bytes as base64. A DER export is two files and the console’s own door sends only the private one, which is the single difference between them.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
files list    
files[].base64 string    
files[].mime string    
files[].name string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
files list    
files[].base64 string    
files[].mime string    
files[].name string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/import-ca

importPkiCa

Use a certificate authority this service did not generate

Paste a CA certificate and its private key. With useCase: "root" it becomes the service Root and every branch must then be rebuilt under it; otherwise it becomes one scope’s Issuing CA for one use case, and everything under that authority is re-minted from it.

THREE CHECKS HAPPEN BEFORE ANYTHING IS STORED, and the middle one is the one that matters: both halves must be present (a certificate with no key is a trust anchor rather than an authority), the KEY MUST BELONG TO THE CERTIFICATE (an authority whose key is somebody else’s issues certificates that verify nowhere, and the failure arrives at a relying party rather than here), and the certificate must be a CA at all — cA:FALSE means nothing it signs is accepted by a path validator.

THE KEY IS STORED AS THIS SERVICE STORES ITS OWN: in the keystore row, sealed under the key-encryption key wherever that key outlives the process.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
certificatePem string yes The CA certificate.
privateKeyPem string yes Its private key.
scope string   *service for the Root, otherwise a realm id or *process.
useCase one of root, jose, xml, assertions, tls, cell, spiffe, pep-tls, realm-tls, kdc, acme, est, scep, tls-client, message-signing yes root, or one of the use cases.

200: The authority as it was read, and what has to happen next.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/issue

issuePkiKeyPair

Issue a signing key pair to an application — or, with target=person, to somebody in ou=users — from the Issuing CA

Generates a key pair, signs a leaf certificate for it with this realm’s Issuing CA, and writes the whole lot onto that application’s directory entry.

WHICH ATTRIBUTES DEPENDS ON purpose, AND THE TWO SETS SHARE NONE. jwt (the default, RFC 7523) writes seven — oauthAssertionPrivateKey, oauthAssertionCertificate, oauthAssertionCertificateChain, oauthAssertionJwks (with x5c and x5t#S256 on the key), oauthAssertionKid, oauthAssertionExpiresAt and oauthAssertionKeySource (issued). saml (RFC 7522) writes six under oauthSamlAssertion*, with no JWKS among them because SAML has none — what a party registers for that profile IS a certificate — and with a oauthSamlAssertionThumbprint where the other has a kid, because those are the handles the two formats actually carry.

AN APPLICATION MAY HOLD BOTH KEY PAIRS AND NEITHER CAN SIGN FOR THE OTHER’S PROFILE. No verifier reads the other set, so issuing one leaves the other untouched and taking one off leaves the other working. The SAML leaf also carries the RFC 7522 grant-type URI as a second URI subjectAltName, so a certificate read out of context says which profile it was issued for.

THIS SERVICE KEEPS NO SECOND COPY OF THE PRIVATE KEY. common/pki.js hands it over once and forgets it, so the entry is where it lives.

AND IT IS SEALED THERE. AES-256-GCM under the key-encryption key, through common/keystore.js — the same mechanism and the same key that seal this service’s own signing keys and the CA hierarchy this leaf was issued from — wherever that key outlives the process, which is product mode. So an ldapsearch on TCP 389 where every bind succeeds, an ldif file, a database row and a backup of either hold $aesgcm$…. GET /admin-api/applications opens it for you, because it comes through common/applications.js and you are holding an admin:read token; in development mode it is in the clear, where the key-encryption key is ephemeral and would not survive the restart the entry does. Issuing again replaces.

THE LEAF IS A digital-signature CERTIFICATE and deliberately carries no extended key usage. What it signs is a JWT, not a TLS handshake; giving it clientAuth would make it usable for RFC 8705 as well, which is a DIFFERENT credential with a different registration attribute, and one certificate quietly doing both is how a deployment ends up unable to revoke either.

A KEY PAIR IS NOT A TRUST DECISION. It lets the application SIGN, which is all RFC 7523 section 2.2 (client authentication) needs. For section 2.1 — the authorization grant — the iss it will use must also be declared on oauthAssertionIssuer, through POST /admin-api/applications/add. RFC 7522 is the same two acts with its own declaration, oauthSamlAssertionIssuer.

THE LIFETIME IS CLAMPED to the Issuing CA’s own expiry rather than refused where it would overshoot: the ordinary cause is a five-year Issuing CA in its fifth year.

AND SINCE 2026-09-11 THE SUBJECT MAY BE A PERSON. target=person issues to somebody in ou=users instead: the same hierarchy, the same profile, the same certificate, ADDED to the key pairs on their own entry — a stsAssertionKeyPair record and a SEALED stsAssertionPrivateKey value per key pair, several per profile since #1290, up to pki.personSigningKeyMax valid ones (STS-PKI-0223 past it), each named by an optional label — an attribute set that shares no name with the application’s and is read by nothing else, which is the same rule the two profiles above follow. RFC 7523 section 3 asks only that iss be a unique identifier for the issuer and says the sub of an authorization grant typically identifies a resource owner, so a person signing for themselves is the profile read literally.

A PERSON MAY ONLY ASSERT ABOUT THEMSELVES, and the grant refuses anything else: a key issued to one resource owner is that person’s credential rather than permission to speak for the others, and the certificate carries urn:sts:person:<name> as a URI subjectAltName so that the rule holds for an assertion presented on its x5c alone. A party that may assert about OTHER people is an application with oauthAssertionIssuer declared on it.

AND THIS REPLY CARRIES THE PRIVATE KEY, WHICH THE APPLICATION’S DOES NOT. An application’s is readable through GET /admin-api/applications, which opens the seal for an admin:read token; a person’s entry is not drawn through any module that would open it, so the alternatives were a page that prints somebody’s private key on every visit or a key nobody can ever obtain. privateKeyPem is in the reply to target=person and in no other answer this API gives, and it is not shown again.

AND SINCE 2026-09-13 A PERSON MAY HOLD AN RFC 7522 KEY PAIR TOO: target=person with purpose=saml adds a stsSamlAssertionKeyPair record (the certificate, its chain, its thumbprint, expiry and provenance) and a sealed stsSamlAssertionPrivateKey value — a fourth attribute set sharing no name with the others. The SAML 2.0 bearer grant reads it under the same rule: the <Subject> must be that person.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
commonName string   The leaf’s CN. Defaults to the identifier. The identifier also goes into a URI subjectAltName either way, because a CN is a display name and a SAN is the machine-readable one.
days integer   How long the certificate is valid. Defaults to pki.leafLifetimeDays.
identifier string yes The application to issue to — or the USERNAME, with target=person. It must ALREADY EXIST in this realm — creating one here would be this endpoint inventing an application, or a person, in order to give it a credential.
issuer string   target=person only: the iss (or SAML <Issuer>) their assertions will carry, written as stsAssertionIssuer or stsSamlAssertionIssuer. Defaults to their username, which the grant accepts without anything being declared — asking an operator to write a name down twice is a configuration step with no decision in it.
keyAlg one of rsa-2048, rsa-3072, rsa-4096, ec-p256, ec-p384, ec-p521, ed25519, ml-dsa-44, ml-dsa-65, ml-dsa-87, slh-dsa-sha2-128s, slh-dsa-sha2-128f, slh-dsa-sha2-192s, slh-dsa-sha2-192f, slh-dsa-sha2-256s, slh-dsa-sha2-256f, slh-dsa-shake-128s, slh-dsa-shake-128f, slh-dsa-shake-192s, slh-dsa-shake-192f, slh-dsa-shake-256s, slh-dsa-shake-256f, mldsa44-rsa2048-pss-sha256, mldsa44-rsa2048-pkcs15-sha256, mldsa44-ed25519-sha512, mldsa44-ecdsa-p256-sha256, mldsa65-rsa3072-pss-sha512, mldsa65-rsa3072-pkcs15-sha512, mldsa65-rsa4096-pss-sha512, mldsa65-rsa4096-pkcs15-sha512, mldsa65-ecdsa-p256-sha512, mldsa65-ecdsa-p384-sha512, mldsa65-ed25519-sha512, mldsa87-ecdsa-p384-sha512, mldsa87-ed448-shake256, mldsa87-rsa3072-pss-sha512, mldsa87-rsa4096-pss-sha512, mldsa87-ecdsa-p521-sha512, ml-kem-512, ml-kem-768, ml-kem-1024   The LEAF’s key algorithm. Defaults to the Issuing CA’s, which is the chain a client library is least likely to be surprised by.
label string   target=person only: what the person calls this key pair — at most 40 letters, digits, spaces, dots, dashes, underscores and brackets (#1290). Optional.
purpose one of jwt, saml   Which assertion profile the key pair is for: jwt for RFC 7523 and saml for RFC 7522. Defaults to jwt, which is what every caller written before this field existed sends and is why it is the default rather than a required field. A value this service does not know is REFUSED rather than defaulted — a caller that asked for a profile wants a certificate for something, and quietly handing back the other one would put a key pair on the wrong attribute set with nothing saying so.
target one of application, person   WHO the key pair is for. Defaults to application, which is what every caller written before this field existed sends. person adds a key pair to stsAssertion* (or stsSamlAssertion* for purpose=saml) on a ou=users entry instead and returns the private key once.

200: The purpose, the attributes it wrote, the key handle (kid and thumbprint — both are returned whichever profile was asked for, because both are computed at issuance), the expiry and the JWS algorithm the issued key signs with. The key material itself is on the application entry.

Member Type Required What it is
attributes list    
attributes[] string    
certificatePem string    
chainPem string    
declared boolean    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
issuer string    
jwks object    
jwks.keys list    
jwks.keys[].alg string    
jwks.keys[].crv string    
jwks.keys[].e string    
jwks.keys[].ek string    
jwks.keys[].ext boolean    
jwks.keys[].key_ops list    
jwks.keys[].key_ops[] string    
jwks.keys[].kid string    
jwks.keys[].kty string    
jwks.keys[].n string    
jwks.keys[].pub string    
jwks.keys[].use string    
jwks.keys[].x string    
jwks.keys[].x5c list    
jwks.keys[].x5c[] string    
jwks.keys[].x5t string    
jwks.keys[].x5t#S256 string    
jwks.keys[].x5u string    
jwks.keys[].y string    
jwsAlg string, or null    
kid string    
label string    
message string    
notAfter string    
ok boolean yes  
person string    
privateKeyPem string    
purpose string    
serialHex string    
target string    
thumbprint string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
attributes list    
attributes[] string    
certificatePem string    
chainPem string    
declared boolean    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
issuer string    
jwks object    
jwks.keys list    
jwks.keys[].alg string    
jwks.keys[].crv string    
jwks.keys[].e string    
jwks.keys[].ek string    
jwks.keys[].ext boolean    
jwks.keys[].key_ops list    
jwks.keys[].key_ops[] string    
jwks.keys[].kid string    
jwks.keys[].kty string    
jwks.keys[].n string    
jwks.keys[].pub string    
jwks.keys[].use string    
jwks.keys[].x string    
jwks.keys[].x5c list    
jwks.keys[].x5c[] string    
jwks.keys[].x5t string    
jwks.keys[].x5t#S256 string    
jwks.keys[].x5u string    
jwks.keys[].y string    
jwsAlg string, or null    
kid string    
label string    
message string    
notAfter string    
ok boolean yes  
person string    
privateKeyPem string    
purpose string    
serialHex string    
target string    
thumbprint string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/issue-certificate

issuePkiCertificate

Issue a certificate from the form — any profile, any issuer, every extension

The pane’s own button. Generates a key pair (unless pki_reuse_key names one in the boxes), builds the certificate from the subject, the validity and the twenty-two extensions, signs it with the authority pki_issuer names — or with its own key under a self-signed profile — and keeps both in this realm’s store.

THE SIGNATURE IS CONSTRAINED BY THE ISSUER’S KEY AND NOT THE SUBJECT’S. A pair whose families disagree is refused HERE with the list of what that key can produce, rather than by the primitive, which reports it as a key-usage error naming neither.

A REFUSAL CARRIES THE FORM BACK in draft: a hundred and fifteen fields discarded because one line of a subjectAltName would not parse is not a refusal anybody can act on.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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

An empty object.

200: The stored object (no private key in it), and the form with a FRESH SERIAL in it — a serial that stayed put would be re-used by the next certificate the same authority signs, and two certificates from one issuer sharing a serial are indistinguishable to anything that revokes, caches or pins by (issuer, serial).

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
dropped integer    
errors list    
errors[] string    
message string    
object object    
object.altKeyAlg string, or null    
object.altPublicKeyPem string, or null    
object.altSigned boolean    
object.ca boolean    
object.certificatePem string    
object.createdAt string, or number, or null    
object.csrPem string    
object.expired boolean    
object.hasCsr boolean    
object.hasPrivateKey boolean    
object.id string    
object.issuerId string, or null    
object.issuerSubject string    
object.keyAlg string    
object.keyAlgLabel string    
object.notAfter string    
object.notBefore string    
object.pqMode string    
object.pqc object    
object.pqc.algorithm string    
object.pqc.family string    
object.pqc.kind string    
object.pqc.label string    
object.pqc.standard string    
object.profile string    
object.profileLabel string    
object.publicKeyPem string    
object.selfSigned boolean    
object.serialHex string    
object.signatureAlg string    
object.signatureAlgLabel string    
object.subject string    
object.thumbprint string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
dropped integer    
errors list    
errors[] string    
message string    
object object    
object.altKeyAlg string, or null    
object.altPublicKeyPem string, or null    
object.altSigned boolean    
object.ca boolean    
object.certificatePem string    
object.createdAt string, or number, or null    
object.csrPem string    
object.expired boolean    
object.hasCsr boolean    
object.hasPrivateKey boolean    
object.id string    
object.issuerId string, or null    
object.issuerSubject string    
object.keyAlg string    
object.keyAlgLabel string    
object.notAfter string    
object.notBefore string    
object.pqMode string    
object.pqc object    
object.pqc.algorithm string    
object.pqc.family string    
object.pqc.kind string    
object.pqc.label string    
object.pqc.standard string    
object.profile string    
object.profileLabel string    
object.publicKeyPem string    
object.selfSigned boolean    
object.serialHex string    
object.signatureAlg string    
object.signatureAlgLabel string    
object.subject string    
object.thumbprint string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/pin-key

pinPkiKeyPair

Use a key pair of your own for one slot

A SLOT is a use case and an algorithm — jose / ES256:P-256, say — which is the granularity an operator actually wants: what signs my ES384, not the key that happened to be there on Tuesday. A kid would not do, because it changes whenever the key does.

WITH NO CERTIFICATE THIS SERVICE ISSUES ONE from that use case’s Issuing CA, so your key chains to this service’s Root exactly as a generated one would — which is what somebody who wants their own key under this hierarchy is asking for. WITH a certificate the pair is used as supplied and chains wherever that certificate chains, which is the other thing somebody might mean.

AS A SIGNER (#263): where the realm’s pki.pinnedSigners is on (it is OFF by default), a pin into a jose or xml slot becomes the key the realm SIGNS with for that algorithm. It is published at once and signs after pki.pinnedSignerLeadMinutes; a signing-key-rotated event is sent; the key must be of the slot’s type (STS-PKI-0207 — ML-DSA and SLH-DSA slots included); and its lifecycle is yours: it is never rotated and ends with its certificate. With the setting off, a pin into a slot the realm signs from is refused.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
certificatePem string   Optional. Omit it and this service issues one from its own authority.
chainPem string   Optional, with certificatePem: the certificates above it, the one that issued it first. A pinned signing key publishes them as its x5c; each must have issued the one before (STS-PKI-0209).
privateKeyPem string yes Your private key.
scope string   A realm id or *process.
slot string yes The algorithm, as it appears in that use case’s certified list — RS256, ES256:P-256, EdDSA:Ed25519.
useCase one of jose, xml, assertions, tls, cell, spiffe, pep-tls, realm-tls, kdc, acme, est, scep, tls-client, message-signing yes The use case.

200: What this service will now use for that slot, and whether it chains to this service’s Root or to yours.

Member Type Required What it is
activatesAt string, or number, or null    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
kid string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
activatesAt string, or number, or null    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
kid string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/recertify

recertifyPkiUseCase

Renew the certificates under one Issuing CA, keeping the keys

Re-issues every certificate that authority has minted, from the SAME authority, with fresh serials and a fresh validity window.

THE KEYS ARE UNTOUCHED, WHICH IS WHAT MAKES THIS A RENEWAL: the subject public key is read back out of the certificate being replaced, so nothing that verifies against the published JWKS stops verifying. reissue-use-case is the other one — it replaces the authority, and everything it had signed chains to nothing until it is re-minted.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
scope string   A realm id or *process.
useCase one of jose, xml, assertions, tls, cell, spiffe, pep-tls, realm-tls, kdc, acme, est, scep, tls-client, message-signing yes The use case to renew.

200: How many certificates were renewed.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/reissue-use-case

reissuePkiUseCase

Give one use case’s Issuing CA a new key pair

Re-issues that one authority from its scope’s Intermediate with a NEW KEY, then re-certifies everything that hung under it. The other use cases are untouched, which is the whole reason each has an authority of its own rather than sharing one: an operator who wants to replace what signs their SAML documents should not thereby replace what signs their tokens.

It is NOT the same as recertify — see that one.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
scope string   A realm id or *process.
useCase one of jose, xml, assertions, tls, cell, spiffe, pep-tls, realm-tls, kdc, acme, est, scep, tls-client, message-signing yes One of jose, xml, assertions, spiffe, pep-tls (a realm) or tls (the process). Asking for one in the wrong scope is refused and the refusal says which scope it belongs to.

200: How many certificates were re-minted under the new authority.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/release-hold

releasePkiCertificateHold

Lift a certificateHold — the one revocation RFC 5280 lets you undo

Takes the serial back off the authority’s list and bumps the CRL number, so the next CRL and the next OCSP answer call it good again.

ONLY A HOLD. A serial revoked for any other reason is refused with the reason named: everything else RFC 5280 defines is PERMANENT, and a validator is entitled to cache a permanent revocation for as long as the CRL it read says it is fresh — so undoing one here would produce a certificate this service calls good and half the world still calls revoked.

AND EVEN A HOLD IS NOT LIFTED INSTANTLY ANYWHERE BUT HERE: a validator holding the previous list goes on refusing until that copy expires, which is pki.crlLifetimeMinutes.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
ca string yes The issuing authority the hold is on. It has to be the same one that took it — a serial is only unique within an issuer.
scope string   As on revoke-certificate: a realm id, *service, *process, or omitted for the realm this request arrived in.
serialHex string yes The held certificate’s serial, spelt however you like.

200: The sentence saying the hold is lifted, and that a validator which cached the earlier list still has it.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/remove-object

removePkiObject

Remove one object from this realm’s store

The key pair is gone. Anything it ISSUED is kept — those certificates are still valid documents — and will now say that their issuer is missing.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
objectId string yes The id of a row in workbench.objects.

200: The sentence saying what that did and did not do.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/revoke

revokePkiKeyPair

Take an issued key pair off an application — which is NOT revocation — or revoke one of a person’s

Clears the attributes the issue wrote FOR ONE PROFILE — seven for jwt and six for saml. An application commonly holds both key pairs and this takes ONE off; clearing both would be an operation whose name said one thing and did two.

THIS OPERATION IS NOT THE ONE THAT REVOKES A CERTIFICATE, AND SINCE 2026-09-11 THERE IS ONE. revoke-certificate puts a serial on an issuer’s revocation list; this takes a key pair off an application entry and puts nothing on any list. After it the certificate is still valid, still chains to this realm’s Root, and would still verify anywhere that trusts that Root. What changes is that THIS service will no longer accept an assertion signed with that key, because the key is no longer registered against the application. The name is revoke because that is the word on the button; the description is where the claim is kept honest.

target=person REVOKES ONE OF A PERSON’s KEY PAIRS (#1290, rcbj: a person’s key pair is removed by revoking it, as on /portal/signing-key, and this replaced taking it off). Name it by handle — its kid for jwt, its certificate thumbprint for saml — and give one of the two reasons a holder may give, cessationOfOperation (the default) or keyCompromise. Its certificate goes on its issuing authority’s CRL and the OCSP responder answers revoked (a certificate an external authority issued is marked revoked here only), its private half is dropped, and this service stops accepting what it signs; the person’s other key pairs keep working. Revoking the LAST valid key pair of a profile clears that profile’s issuer declaration with it, because a person declared as an issuer with no key to issue with is a key pair that would not go away.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
handle string   target=person only: the key pair to revoke — its kid (jwt) or certificate thumbprint (saml), as GET /admin-api/users?user= lists it, or its certificate’s serial in hex. Only that person’s key pairs are searched.
identifier string yes The application to take the key pair off — or the USERNAME, with target=person.
purpose one of jwt, saml   Which profile’s key pair. Defaults to jwt. The other profile is untouched either way.
reason one of cessationOfOperation, keyCompromise   target=person only: why. Defaults to cessationOfOperation; keyCompromise also raises a RISC credential-compromise event.
target one of application, person   WHOSE key pair. Defaults to application, which is what every caller written before this field existed sends. person revokes one of a ou=users entry’s key pairs, named by handle.

200: Whether anything was taken off, and the sentence saying what that did and did not do.

Member Type Required What it is
already boolean    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
label string    
message string    
ok boolean yes  
onList boolean    
person string    
purpose string    
reason string, or null    
remaining integer    
serialHex string    
target string    
undeclared boolean    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
already boolean    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
label string    
message string    
ok boolean yes  
onList boolean    
person string    
purpose string    
reason string, or null    
remaining integer    
serialHex string    
target string    
undeclared boolean    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/revoke-certificate

revokePkiCertificate

Put a serial on one certificate authority’s revocation list — which is NOT revoke

RFC 5280 revocation: the serial goes on the named authority’s CRL and its OCSP responder answers revoked for it from that moment. The list is rebuilt and signed on demand at /pki/crl/{scope}/{ca}, so the next fetch there already carries the entry, and the copy published into the directory under ou=crl is rewritten too — the ldap:// and ldaps:// addresses in every certificate this authority signed point at a DOCUMENT, and a document goes on saying what it said before unless somebody rewrites it.

THIS IS NOT revoke, WHICH IS A DIFFERENT ACT WITH THE SAME WORD IN IT. That one takes an issued key pair off an application’s directory entry and puts nothing on any list. This one puts a serial on a list and takes nothing off anybody. The names are deliberately not revoke and revoke-key: this action list is published and a machine chooses from it, so renaming the older one to make room would have broken every caller that already had it.

IT IS IDEMPOTENT AND THE EARLIER ENTRY WINS — revoking twice answers 200 with already: true and does not move the date, because a validator is entitled to act on the first moment it was told about.

AND THIS SERVICE DOES NOT CONSULT ITS OWN LISTS. A client certificate revoked here still authenticates on the main port and LDAPS 636, because those check the truststore’s anchors and fetch nothing. What this operation buys is that a relying party which DOES check can now find out.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
ca string yes The issuing authority, as GET /admin-api/pki names it in revocation: root, intermediate, or a use case id for an Issuing CA. A revocation is made BY AN ISSUER — a serial is only unique within one, which is why there is a list per CA and not one per realm.
note string   Optional. Why, in your own words, for the same reader.
reason one of unspecified, keyCompromise, cACompromise, affiliationChanged, superseded, cessationOfOperation, certificateHold, privilegeWithdrawn, aACompromise   RFC 5280 section 5.3.1. Defaults to superseded, which is what this service uses when it rotates or reissues something itself. certificateHold is the only one release-hold can undo; unspecified writes no reason code at all, which is what that value means on the wire.
scope string   Which branch the issuer is in: a realm id, *service for the one Root, *process for the process branch, or omitted for the realm this request arrived in.
serialHex string yes The certificate’s serial number in hex. Case, leading zeros and separators are all ignored: a CRL carries a DER integer and an OCSP request carries a string somebody typed, and two spellings of one serial is a certificate that is revoked and reports as good.
subject string   Optional. The subject DN, kept for the operator reading the list — it is not on the CRL, which carries serials.

200: The entry as it now stands, already when it was on the list before, and the sentence saying what this did and did not change.

Member Type Required What it is
already boolean    
draft map    
draft.{key} string, or boolean, or null    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode integer    
entry.reasonWhat string    
entry.revokedAt string, or number, or null    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
already boolean    
draft map    
draft.{key} string, or boolean, or null    
entry object    
entry.note string    
entry.reason string    
entry.reasonCode integer    
entry.reasonWhat string    
entry.revokedAt string, or number, or null    
entry.serialHex string    
entry.subject string    
errors list    
errors[] string    
message string    
ok boolean yes  
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

GET /admin-api/pki/trust

getPkiTrust

Paranoid PKI mode, the signer truststore and what is pinned

Everything /admin/pki/trust draws: the master and every use case’s row, this realm’s signer truststore, and what the realm pins as the daily audit last found it.

Mirrors GET /admin/pki/trust on the admin console.

Scope: admin:read.

Parameters

Name In Type Required What it is
pinsPage query integer   Which page of pins to return, answered by pinsPaging. The pinned certificates, newest first.
per query integer   Rows per page. Defaults to 50 and is capped at 300. On a drill-down it is SHARED by every list in the reply, which each carry a page number of their own.
DPoP header string   RFC 9449: the proof of possession for a DPoP-bound access token, as Authorization: DPoP <token> requires.
cell query string   The cell to answer this request, where this service runs as several. Ignored in a service that runs as one.

200: The trust view of this realm.

Member Type Required What it is
actions list    
actions[] string    
assessedAt number    
clientTruststore object    
clientTruststore.count integer    
clientTruststore.href string    
master object    
master.decidedBy string    
master.inForce boolean    
master.product boolean    
master.value one of auto, on, off    
pins list    
pins[].chainedTo string    
pins[].fingerprint256 string    
pins[].href string    
pins[].notAfter number    
pins[].notBefore number    
pins[].purpose string    
pins[].revocation string    
pins[].selfSigned boolean    
pins[].source string    
pins[].status one of valid, expiring, expired, not-yet-valid, revoked, chain-missing, self-signed, thumbprint-only, unreadable    
pins[].subject string    
pins[].thumbprint string    
pins[].where string    
pinsPaging object    
pinsPaging.firstRow integer    
pinsPaging.lastRow integer    
pinsPaging.noun string    
pinsPaging.page integer    
pinsPaging.pages integer    
pinsPaging.param string    
pinsPaging.perPage integer    
pinsPaging.total integer    
pinsTotal integer    
realm string    
rows list    
rows[].adds string    
rows[].anchors list    
rows[].anchors[] string    
rows[].assessed integer    
rows[].covers string    
rows[].exemptions list    
rows[].exemptions[].check string    
rows[].exemptions[].spec string    
rows[].inForce boolean    
rows[].lastRefusal string    
rows[].on boolean    
rows[].phase integer    
rows[].purpose string    
rows[].refused integer    
rows[].setting string    
rows[].title string    
truststore object    
truststore.anchors integer    
truststore.entries list    
truststore.entries[].addedAt string    
truststore.entries[].addedBy string    
truststore.entries[].fingerprint256 string    
truststore.entries[].issuer string    
truststore.entries[].kind string    
truststore.entries[].notAfter number    
truststore.entries[].notBefore number    
truststore.entries[].pem string    
truststore.entries[].purposes list    
truststore.entries[].purposes[] string    
truststore.entries[].source string    
truststore.entries[].subject string    
truststore.entries[].unadmittable string    
truststore.file string    
truststore.installed boolean    
truststore.intermediates integer    
truststore.loadedFromFile integer    
truststore.maxAnchors integer    
truststore.maxIntermediates integer    

POST /admin-api/pki/trust/add

addSignerTrustAnchors

Trust a third party’s certificate authorities in this realm

One or more PEM certificates, each through the admission rule: a self-signed CA is an anchor, any other CA an intermediate that must chain to an anchor held, and a leaf is refused by name.

Mirrors POST /admin/pki/trust 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
certificates list, or string yes  
certificates[] string    
kind one of anchor, intermediate, accepted   Omitted: a self-issued certificate is an anchor, any other an intermediate. accepted: one leaf a server presents, trusted as itself for outbound TLS and for nothing else.
purposes list, or string    
purposes[] string    

200: What was added, what was already held and each refusal by name.

Member Type Required What it is
added list    
added[].addedAt string    
added[].addedBy string    
added[].fingerprint256 string    
added[].issuer string    
added[].kind string    
added[].notAfter number    
added[].notBefore number    
added[].pem string    
added[].purposes list    
added[].purposes[] string    
added[].source string    
added[].subject string    
added[].unadmittable string    
duplicates integer    
errors list    
errors[] string    
message string    
ok boolean yes  
refused list    
refused[].subject string    
refused[].why string    

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

Member Type Required What it is
added list    
added[].addedAt string    
added[].addedBy string    
added[].fingerprint256 string    
added[].issuer string    
added[].kind string    
added[].notAfter number    
added[].notBefore number    
added[].pem string    
added[].purposes list    
added[].purposes[] string    
added[].source string    
added[].subject string    
added[].unadmittable string    
duplicates integer    
errors list    
errors[] string    
message string    
ok boolean yes  
refused list    
refused[].subject string    
refused[].why string    

POST /admin-api/pki/trust/recheck

recheckPinnedCertificates

Audit what this realm pins, now

What the daily pki.pins.audit job does, on demand: it keeps the result, and logs and mails what changed.

Mirrors POST /admin/pki/trust on the admin console.

Scope: admin:write.

Parameters

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

Request body (optional)

An empty object.

200: How many were audited and how many changed.

Member Type Required What it is
changes integer    
errors list    
errors[] string    
message string    
ok boolean yes  
pins integer    
truststore integer    

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

Member Type Required What it is
changes integer    
errors list    
errors[] string    
message string    
ok boolean yes  
pins integer    
truststore integer    

POST /admin-api/pki/trust/remove

removeSignerTrustAnchor

Stop trusting a certificate in this realm’s signer truststore

By its SHA-256 fingerprint, in either spelling. An entry from pki.signerTrustAnchorsFile is refused: it would come back at the next start.

Mirrors POST /admin/pki/trust 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
fingerprint string yes  

200: Whether it was removed.

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

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

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

POST /admin-api/pki/trust/set-row

setParanoidPkiRow

Set paranoid PKI mode, or one use case’s row

pki.paranoid (auto, on, off) or one pki.paranoid<UseCase> (true, false), for this realm, through the ordinary settings write.

Mirrors POST /admin/pki/trust 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
setting string yes  
value string, or boolean yes  

200: The setting written.

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

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

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

POST /admin-api/pki/unpin-key

unpinPkiKeyPair

Stop using a pinned key pair for one slot

The undoing of pin-key (#263). For a pinned SIGNING key the key this service generated signs again at once — it was published all along — and the pinned key stays published, verifying what it signed, through its unit’s grace (signing.retire drops it then). A signing-key-rotated event is sent. A slot holding a pin that never signed is simply cleared. Nothing pinned in the slot is STS-PKI-0211.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
scope string   A realm id; empty for this realm.
slot string yes The slot the key was pinned in.
useCase one of jose, xml, assertions, tls, cell, spiffe, pep-tls, realm-tls, kdc, acme, est, scep, tls-client, message-signing yes The use case.

200: Which pinned key stopped signing, and until when it goes on verifying.

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
unpinned list    
unpinned[] string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
message string    
ok boolean yes  
unpinned list    
unpinned[] string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

POST /admin-api/pki/upload-certificate

uploadPkiCertificate

Replace an application’s or a person’s key pair with a certificate it already holds — issued by this realm’s CA, or by another with its full chain

The application generated its own key pair and brings the CERTIFICATE; this writes it over the key pair this service manages for one profile, onto the same attributes an issue writes — seven for jwt, six for saml — with the private key attribute CLEARED and oauthAssertionKeySource / oauthSamlAssertionKeySource saying where it came from. No private key is taken: an upload carrying one is refused and nothing is stored.

WHAT THE CHAIN MUST BE DEPENDS ON WHO ISSUED IT. A certificate from THIS REALM’s own certificate authority may be sent alone — the service holds every tier above it — and is held to the path check an x5c is: it must pass through this realm’s own Intermediate and nothing on it may be revoked (uploaded-realm-ca). A certificate from ANY OTHER authority must arrive with its WHOLE chain, every intermediate and a SELF-SIGNED root, in either field and in any order (uploaded-external-ca). Every link is verified — signature, issuer name, validity — every issuer must be a CA permitted keyCertSign within its path length constraint, the leaf must not be a CA and must permit digitalSignature, and its revocation is checked the way a registered certificate is when it is used. An incomplete chain, an unrelated extra certificate, a self-signed leaf, and a chain to this SERVICE’s Root through ANOTHER realm’s Intermediate are each refused by name. The external root need not be trusted by anything here: the application is registering a KEY and the chain is the evidence for it.

THE KEY MUST BE ONE THE PROFILE’s VERIFIER CAN USE: RSA of at least 2048 bits, ECDSA on P-256, P-384 or P-521 — and for jwt also secp256k1 or Ed25519. The chain is stored WITH its root for an external authority, because revocation checking needs every issuer; the JWKS written for jwt carries it in x5c.

Like issue, a key pair is not a trust decision: the issuer the application will assert as still has to be declared for section 2.1.

target=person (2026-09-13) ADDS A KEY PAIR TO A PERSON’s (since #1290; it replaced the one held until then) — stsAssertion* or stsSamlAssertion* on their ou=users entry, with an optional label, under pki.personSigningKeyMax — under the same chain rules, with one more: a certificate this realm issued must name THAT person (urn:sts:person:<name>), so an application’s leaf or another person’s is refused. For an application, a leaf this realm issued to a PERSON is refused. A self-signed certificate is refused for a person with no by-value alternative, and the grant still holds an uploaded key to assertions about the person alone.

Mirrors POST /admin/pki, POST /admin/pki/certificate and POST /admin/pki/person 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
certificate string yes The leaf certificate, PEM. It may be followed by its chain in the same value.
chain string   The certificates above it, PEM, in any order: every intermediate and the self-signed root for an external authority, nothing for this realm’s own.
from string   Console only: the page to return to. Ignored by this API.
identifier string yes The application, exactly as the registry holds it — or the USERNAME, with target=person.
label string   target=person only: what the person calls this key pair, at most 40 characters. Optional.
purpose one of jwt, saml   Which profile’s key pair to replace. Defaults to jwt; the other is untouched.
target one of application, person   WHOSE key pair. Defaults to application; person ADDS a key pair to a ou=users entry, which must already exist (#1290).

200: The source, the subject and issuer, the chain it was checked through, the key handle and the expiry — or the refusal naming what is wrong with the chain.

Member Type Required What it is
attributes list    
attributes[] string    
chain list    
chain[] string    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
issuer string    
jwsAlg string, or null    
kid string    
label string    
message string    
notAfter string    
ok boolean yes  
person string    
purpose string    
revocation object    
revocation.policy string    
revocation.status string    
serialHex string    
source string    
subject string    
target string    
thumbprint string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string    

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

Member Type Required What it is
attributes list    
attributes[] string    
chain list    
chain[] string    
draft map    
draft.{key} string, or boolean, or null    
errors list    
errors[] string    
handle string    
issuer string    
jwsAlg string, or null    
kid string    
label string    
message string    
notAfter string    
ok boolean yes  
person string    
purpose string    
revocation object    
revocation.policy string    
revocation.status string    
serialHex string    
source string    
subject string    
target string    
thumbprint string    
why string    
workbench object    
workbench.accessMethods list    
workbench.accessMethods[] string    
workbench.alternativeKeyAlgorithms list    
workbench.alternativeKeyAlgorithms[].family string    
workbench.alternativeKeyAlgorithms[].id string    
workbench.alternativeKeyAlgorithms[].kind string    
workbench.alternativeKeyAlgorithms[].label string    
workbench.alternativeKeyAlgorithms[].signs boolean    
workbench.alternativeKeyAlgorithms[].slow boolean    
workbench.dnFields list    
workbench.dnFields[].attr string    
workbench.dnFields[].field string    
workbench.draft map    
workbench.draft.{key} string, or boolean, or null    
workbench.extendedKeyUsages list    
workbench.extendedKeyUsages[].name string    
workbench.extendedKeyUsages[].oid string    
workbench.fields list    
workbench.fields[] string    
workbench.issuers list    
workbench.issuers[].hasAlternativeKey boolean    
workbench.issuers[].id string    
workbench.issuers[].keyAlg string    
workbench.issuers[].label string    
workbench.issuers[].notAfter string    
workbench.issuers[].subject string    
workbench.keyAlgorithms list    
workbench.keyAlgorithms[].family string    
workbench.keyAlgorithms[].id string    
workbench.keyAlgorithms[].kind string    
workbench.keyAlgorithms[].label string    
workbench.keyAlgorithms[].signs boolean    
workbench.keyAlgorithms[].slow boolean    
workbench.keyUsageBits list    
workbench.keyUsageBits[].name string    
workbench.keyUsageBits[].what string    
workbench.keystoreFormats list    
workbench.keystoreFormats[] string    
workbench.maxObjects integer    
workbench.netscapeTypes list    
workbench.netscapeTypes[].name string    
workbench.objects list    
workbench.objects[].altKeyAlg string, or null    
workbench.objects[].altPublicKeyPem string, or null    
workbench.objects[].altSigned boolean    
workbench.objects[].ca boolean    
workbench.objects[].certificatePem string    
workbench.objects[].createdAt string, or number, or null    
workbench.objects[].csrPem string    
workbench.objects[].expired boolean    
workbench.objects[].hasCsr boolean    
workbench.objects[].hasPrivateKey boolean    
workbench.objects[].id string    
workbench.objects[].issuerId string, or null    
workbench.objects[].issuerSubject string    
workbench.objects[].keyAlg string    
workbench.objects[].keyAlgLabel string    
workbench.objects[].notAfter string    
workbench.objects[].notBefore string    
workbench.objects[].pqMode string    
workbench.objects[].pqc object    
workbench.objects[].pqc.algorithm string    
workbench.objects[].pqc.family string    
workbench.objects[].pqc.kind string    
workbench.objects[].pqc.label string    
workbench.objects[].pqc.standard string    
workbench.objects[].profile string    
workbench.objects[].profileLabel string    
workbench.objects[].publicKeyPem string    
workbench.objects[].selfSigned boolean    
workbench.objects[].serialHex string    
workbench.objects[].signatureAlg string    
workbench.objects[].signatureAlgLabel string    
workbench.objects[].subject string    
workbench.objects[].thumbprint string    
workbench.pqMode string    
workbench.pqModes list    
workbench.pqModes[].classical boolean    
workbench.pqModes[].families list    
workbench.pqModes[].families[] string    
workbench.pqModes[].id string    
workbench.pqModes[].label string    
workbench.pqModes[].note string    
workbench.profiles list    
workbench.profiles[].ca boolean    
workbench.profiles[].extKeyUsage list    
workbench.profiles[].extKeyUsage[] string    
workbench.profiles[].id string    
workbench.profiles[].keyUsage list    
workbench.profiles[].keyUsage[] string    
workbench.profiles[].label string    
workbench.profiles[].note string    
workbench.profiles[].pathLen integer, or null    
workbench.profiles[].selfSigned boolean    
workbench.profiles[].years number    
workbench.signatureAlgorithms list    
workbench.signatureAlgorithms[].id string    
workbench.signatureAlgorithms[].kind string, or null    
workbench.signatureAlgorithms[].label string    
workbench.signatureAlgorithms[].weak boolean    
workbench.signerLabel string    
workbench.slowFamilies list    
workbench.slowFamilies[] string