POST /api/certificates/by-transport-principal

Find a transport principal's certificates -- BYTE-EXACT, no wildcard.

WARNING: an empty result here does NOT mean the principal has no certificates. This route matches BYTE-EXACT with NO WILDCARD: the underlying operation delegates to the by-subject LIKE with the subject exactly as given. It therefore finds nothing whenever a principal's stored subject is a PREFIX of its certificate's subject name rather than identical to it -- which is the ordinary case for a principal created from a CSR carrying extra RDNs. Measured: a transport principal with subject /CN=...-CA found 0 of the 6 certificates that were actually its own.

The response carries wildcardEquivalent, a ready-to-send POST /api/certificates/by-subject request with a trailing % appended -- that is the broader query, and it is what a thick client uses for this purpose.

Note: wildcardEquivalent.path is a field in the response BODY naming another route. It is not a link header and this route does not follow it for you.

Authentication

Send the session id as Authorization: Bearer <session id>, and an RFC 9449 DPoP proof in the DPoP header if your session is bound to a key. The two are required together, not as alternatives — see Authenticating and Proving you hold your key.

This surface sets no cookie

There is no session cookie on any response and none is read on any request. Do not set credentials: "include" on a browser fetch.

Request

Field	Type	Required	Description
subject	string	yes	Matched byte-exact. No wildcard is applied.
includeBodies	boolean	no

Example

{
  "subject": "...",
  "includeBodies": true
}

Responses

200

The byte-exact matches, which may legitimately be none. Read wildcardEquivalent before concluding anything from an empty list.

Field	Type	Required	Description
lookup	string (by-id, by-subject, by-transport-principal, from-certificate)	yes	Which lookup answered, echoed so a response is self-describing.
systemId	integer	no
principalId	string	no
subject	string	no	Echoed
count	integer	yes
bodiesIncluded	boolean	yes
certificates	array of Certificate	yes	A certificate object as the key server holds or parses it.
detail	string	no
matched	"byte-exact, NO WILDCARD" (constant)	no
wildcardEquivalent	object	no	The broader by-subject query, ready to send.

wildcardEquivalent object

Field	Type	Required	Description
path	string	no
subject	string	no

Example

{
  "lookup": "by-id",
  "systemId": 0,
  "principalId": "...",
  "subject": "...",
  "count": 0,
  "bodiesIncluded": true,
  "certificates": [
    {
      "certificateId": "...",
      "className": "...",
      "subject": "...",
      "issuer": "...",
      "publicKeyType": "...",
      "serialNumber": "...",
      "certHash": "...",
      "effectiveDate": "...",
      "expirationDate": "...",
      "status": 0,
      "statusLabel": "...",
      "certificate": "...",
      "request": "..."
    }
  ],
  "detail": "...",
  "matched": "byte-exact, NO WILDCARD",
  "wildcardEquivalent": {
    "path": "...",
    "subject": "..."
  }
}

400

The request was refused before anything was sent to the key server.

Most 400s on this surface carry code: BAD_REQUEST and a detail naming the field and saying what the key server would otherwise have done with it. A large share of them exist because the value would have been ACCEPTED downstream and quietly meant something else -- an empty string that reaches the wire as "mint a new key", a zero-length identifier that names no object, a numeric flag word that clears bits the caller did not name.

401

No live session, or a DPoP proof that did not verify.

SESSION_NOT_FOUND -- the credential names no session this Gateway holds. SESSION_EXPIRED -- it aged out. Both carry reauth: true; obtain a new credential rather than retrying.

PROOF_* -- the sender constraint refused. See the DPoP section of this document for the full table; PROOF_MALFORMED is a 400 and PROOF_REPLAY_CACHE_FULL a 503, and the rest are here.

SCOPED_CREDENTIAL_EXPIRED -- a scoped browser credential passed its fixed lifetime. Use does not extend it: an idle timeout would be refreshed by exactly the traffic a stolen handle produces.

403

Authenticated, and refused. The codes differ in what they say about where the refusal came from: ACCESS_DENIED and PRINCIPAL_DISABLED are the key server's, while NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent.

500

A fault rather than a refusal.

OP_FAILED is the catch-all: the key server refused in words that match no classified pattern, so the Gateway cannot say more than that the operation did not happen. Some key server refusals that are conceptually a caller error arrive here rather than as a 4xx, because the wire carries no distinguishing code -- where a route can recognise one from its message it maps it, and each such mapping is documented on the operation.

503

A capacity ceiling or a missing deployment prerequisite. retryable says which.

A scope of session or process names the ceiling that was hit, and the response carries Retry-After.

Error handling

Every failure answers JSON carrying at least code and detail. Match on code — detail is written for a human debugging the call and its wording is not part of the contract. See the error model.

Status	Meaning
400	The request was refused before anything was sent to the key server. Most 400s on this surface carry code: BAD_REQUEST and a detail naming the field and saying what the key server would otherwise have done with it. A large share of them exist because the value would have been ACCEPTED downstream and quietly meant something else -- an empty string that reaches the wire as "mint a new key", a zero-length identifier that names no object, a numeric flag word that clears bits the caller did not name.
401	No live session, or a DPoP proof that did not verify. SESSION_NOT_FOUND -- the credential names no session this Gateway holds. SESSION_EXPIRED -- it aged out. Both carry reauth: true; obtain a new credential rather than retrying. PROOF_* -- the sender constraint refused. See the DPoP section of this document for the full table; PROOF_MALFORMED is a 400 and PROOF_REPLAY_CACHE_FULL a 503, and the rest are here. SCOPED_CREDENTIAL_EXPIRED -- a scoped browser credential passed its fixed lifetime. Use does not extend it: an idle timeout would be refreshed by exactly the traffic a stolen handle produces.
403	Authenticated, and refused. The codes differ in what they say about where the refusal came from: ACCESS_DENIED and PRINCIPAL_DISABLED are the key server's, while NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent.
500	A fault rather than a refusal. OP_FAILED is the catch-all: the key server refused in words that match no classified pattern, so the Gateway cannot say more than that the operation did not happen. Some key server refusals that are conceptually a caller error arrive here rather than as a 4xx, because the wire carries no distinguishing code -- where a route can recognise one from its message it maps it, and each such mapping is documented on the operation.
503	A capacity ceiling or a missing deployment prerequisite. retryable says which. A scope of session or process names the ceiling that was hit, and the response carries Retry-After.