POST /api/principals

Create a password, LDAP or group principal by name.

Creates a principal and verifies by reading it back by name.

Only three types are creatable here: password, ldap and group. The other two are refused with an explanation rather than a bare rejection:

• xauth is created at POST /api/principals/xauth, which is idempotent by exact id. Two creation paths for one identity type is how you get two principals with one identity and different ids;
• certificate is not created by name and never was. A transport identity needs TWO records -- a certificate object keyed on the exact digest AND a subject-resolved, enabled transport principal -- and a principal created by name alone has no certificate bound to it and could never authenticate. Use POST /api/certificates/enroll.

A group IS a principal, which is why it is created and listed here rather than under a /api/groups collection; only membership lives under /api/groups.

WARNING: the new principal holds NO roles and therefore NO operations. It can authenticate and do nothing. The key server CLEARS the role list on creation whatever is sent, so roles are always a second call: PUT /api/principals/{id}/roles. Granting access to a KEY is a third, different thing -- a role carries operations, a key ACL carries rights.

WARNING: on a 409 NOT_SAVED, do not simply retry. The key server enforces no uniqueness on principal names, so a retry that succeeds where the read-back failed leaves two principals with one name and different ids. List by type first.

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
type	string (password, ldap, group)	yes
name	string	yes
password	string	no	Required for type: password, and rejected by the key server if it fails policy.

Example

{
  "type": "password",
  "name": "...",
  "password": "..."
}

Responses

200

Created, and read back by name.

Field	Type	Required	Description
created	true (constant)	yes
type	string	yes
saved	boolean	yes
principal	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

Principal

Field	Type	Required	Description
id	string	no	16 hex digits.
principalId	string or null	no	The same eight bytes as a decimal string. A string, so that an id above 2^53 survives.
systemId	integer or null	no	Assigned by the key server at setup. READ IT FROM THE SERVER; a hardcoded value addresses a principal that does not exist and yields a misleading "unknown principal".
className	string or null	no	The key server's own class name -- UserAndPasswordInfo, TransportPrincipalInfo, LdapPrincipalInfo, XAuthPrincipalInfo or GroupInfo.
name	string or null	no
disabled	boolean or null	no
roleIds	array of string	no
groupIds	array of string	no

Example

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

400

BAD_REQUEST -- name empty, type not creatable (the detail says where the other two are created instead), password missing for a password principal, or the password rejected by policy. The policy case additionally carries field: password.

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.

409

NOT_SAVED -- the key server did not refuse and the principal was not present when read back by name. See the retry warning above.

500

NO_CONSTRUCTOR -- an internal fault: no builder is registered for a type that passed validation. Or the shared OP_FAILED.

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 -- name empty, type not creatable (the detail says where the other two are created instead), password missing for a password principal, or the password rejected by policy. The policy case additionally carries field: password.
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.
409	NOT_SAVED -- the key server did not refuse and the principal was not present when read back by name. See the retry warning above.
500	NO_CONSTRUCTOR -- an internal fault: no builder is registered for a type that passed validation. Or the shared OP_FAILED.
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.