GET /api/principals

List principals of one type.

Lists every principal of the named type.

type is REQUIRED and there is no untyped listing. With no type the key server would query the abstract umbrella class, which has no name column of its own and five real subclasses, so the answer could be neither ordered nor bounded.

The READABLE set is wider than the CREATABLE one by exactly two types: xauth is listable here and created at POST /api/principals/xauth; certificate is listable here and created only by ENROLMENT at POST /api/certificates/enroll, never by name.

Each row carries its id in both spellings -- see the Principal schema, because using the wrong one on the next call is the commonest mistake in this family.

There is no paging and no total on this route: the key server returns rows, never a cardinality.

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.

Parameters

Name	In	Required	Type	Description
type	query	yes	string (password, certificate, ldap, xauth, group)

Request

No request body.

Responses

200

The principals of that type.

Field	Type	Required	Description
type	string	yes
className	string	yes	The key server class this type maps to.
count	integer	yes
principals	array of Principal	yes	A principal, carrying its id in BOTH spellings because different routes take different ones. id (16 hex digits) is what this API's {id}, {gid} and {pid} path segments take; principalId (a decimal string of the same eight bytes) together with systemId is what the ACL and export routes take.
detail	string	no

Example

{
  "type": "...",
  "className": "...",
  "count": 0,
  "principals": [
    {
      "id": "...",
      "principalId": "...",
      "systemId": 0,
      "className": "...",
      "name": "...",
      "disabled": true,
      "roleIds": [
        "..."
      ],
      "groupIds": [
        "..."
      ]
    }
  ],
  "detail": "..."
}

400

BAD_REQUEST -- type absent or not one of the five. The detail names them.

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	BAD_REQUEST -- type absent or not one of the five. The detail names them.
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.