Skip to main content

POST /api/acl-templates

Create an ACL template; the caller is always a read+write member.

GET_ACL_TEMPLATE (name check), FIND_PRINCIPAL by the session's user name (the caller's own principal), FIND_PRINCIPAL for any listed member without a systemId, then CREATE_ACL_TEMPLATE, then GET_ACL_TEMPLATE to read back. saved is true only when the re-read shows the name and exactly the requested member set.

The caller is always a member with read AND write. Omit members and the caller is the sole initial member. Send members and the caller is added if absent -- reported as callerAdded: true -- and the caller's own entry is forced to read+write even when the list names them read-only. Every later edit, rename and delete of the template requires the session principal to be a write-holding member, so a template created without its creator could never be administered. An explicit members: [] is a 400: the key server refuses a template with no members.

A member's systemId is resolved from the principal when omitted; give it only to name a principal in another system. A principal this key server does not hold is a 400.

Role: Security Officer; an Administrator on a split deployment receives 403.

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​

FieldTypeRequiredDescription
namestringyesTrimmed before use; whitespace-only is a 400.
membersarray of objectnoOptional. Absent means "the caller alone, read+write". Present must be non-empty; the caller is merged in either way.

members[] object

FieldTypeRequiredDescription
principalIdstringyes
systemIdinteger or nullnoResolved from the principal when absent or null.
readbooleanno
writebooleanno

Example

{
  "name": "...",
  "members": [
    {
      "principalId": "...",
      "systemId": 0,
      "read": true,
      "write": true
    }
  ]
}

Responses​

200​

Created, and read back with the requested members.

FieldTypeRequiredDescription
namestringyesThe trimmed name.
savedbooleanyes
conflictbooleanno
callerAddedbooleannoPresent only when members was sent; true when the caller was not in it.
templateobject or nullnoThe template as GET /api/acl-templates/{id} returns it.

Example

{
  "name": "...",
  "saved": true,
  "conflict": true,
  "callerAdded": true,
  "template": {}
}

400​

BAD_REQUEST -- name empty; members not an array, empty, or an entry with a malformed principalId, a systemId below 1, a non-boolean read/write, or neither right granted; a listed principal this key server does not hold; or a session that names no user, so the caller cannot be made a member.

401​

No live session, a DPoP proof that did not verify, or a certificate session whose certificate the key server now refuses.

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.

CERTIFICATE_REVOKED -- on a session established by certificate login, the key server re-checks the certificate that session was established with on its operations, and it is now named by revocation evidence (ADR 0115). detail is the key server's sentence. Every later operation of the session is refused the same way; log in with a different certificate.

403​

Authenticated, and refused. The codes differ in what they say about where the refusal came from: ACCESS_DENIED (no role grants the operation), ACL_DENIED (the ACL of the key the request named refuses the principal -- ask the key's owner, not an administrator), PRINCIPAL_DISABLED and DELEGATOR_REFUSED are the key server's -- the last one on a DELEGATED session whose delegator has since been disabled, lost its DELEGATION flag, been unenrolled or had its certificate revoked (ADR-0123); its detail is the key server's sentence naming the delegator, and no new login helps until an administrator restores it. REVOCATION_STATUS_UNAVAILABLE and REVOCATION_EVIDENCE_STALE are the key server's too, on a session established by certificate login: the same re-check found no current revocation evidence for that certificate's issuer under a policy that requires it (ADR 0115) -- the credential is not what was refused, and an operator importing a current CRL for the issuer is what helps -- while NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent.

409​

NAME_IN_USE -- a template with that name already exists. Or the create was accepted and the re-read does not show the name and member set: that body is the 200 shape with saved: false and the Gateway adds code: NOT_SAVED and a detail to it (compose.ts).

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.

BUILD_NOT_ADMITTED (scope: process, retryable: true, Retry-After): the key server does not admit this Gateway's client build. Every key-server connection the Gateway opens attests the signed release it runs (TE_RELEASE_MANIFEST) right after it authenticates; while that attestation is refused -- the release is not registered at the key server's code-signing level, the level was raised under it, or the installed files no longer match the signed manifest -- every route but GET /api/health and GET /api/ready answers this, and detail names the cause. It is never a 401 or a 403: no credential or role of the caller's is at fault. The Gateway re-attempts on a timer and recovers without a restart once the key server admits it; GET /api/ready says when.

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.

StatusMeaning
400BAD_REQUEST -- name empty; members not an array, empty, or an entry with a malformed principalId, a systemId below 1, a non-boolean read/write, or neither right granted; a listed principal this key server does not hold; or a session that names no user, so the caller cannot be made a member.
401No live session, a DPoP proof that did not verify, or a certificate session whose certificate the key server now refuses. 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. CERTIFICATE_REVOKED -- on a session established by certificate login, the key server re-checks the certificate that session was established with on its operations, and it is now named by revocation evidence (ADR 0115). detail is the key server's sentence. Every later operation of the session is refused the same way; log in with a different certificate.
403Authenticated, and refused. The codes differ in what they say about where the refusal came from: ACCESS_DENIED (no role grants the operation), ACL_DENIED (the ACL of the key the request named refuses the principal -- ask the key's owner, not an administrator), PRINCIPAL_DISABLED and DELEGATOR_REFUSED are the key server's -- the last one on a DELEGATED session whose delegator has since been disabled, lost its DELEGATION flag, been unenrolled or had its certificate revoked (ADR-0123); its detail is the key server's sentence naming the delegator, and no new login helps until an administrator restores it. REVOCATION_STATUS_UNAVAILABLE and REVOCATION_EVIDENCE_STALE are the key server's too, on a session established by certificate login: the same re-check found no current revocation evidence for that certificate's issuer under a policy that requires it (ADR 0115) -- the credential is not what was refused, and an operator importing a current CRL for the issuer is what helps -- while NOT_WRITABLE, BUILT_IN_PRINCIPAL, OWN_ACCOUNT and OBJECT_NOT_IN_CREDENTIAL_SCOPE are decided by the Gateway before anything is sent.
409NAME_IN_USE -- a template with that name already exists. Or the create was accepted and the re-read does not show the name and member set: that body is the 200 shape with saved: false and the Gateway adds code: NOT_SAVED and a detail to it (compose.ts).
500A 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.
503A 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. BUILD_NOT_ADMITTED (scope: process, retryable: true, Retry-After): the key server does not admit this Gateway's client build. Every key-server connection the Gateway opens attests the signed release it runs (TE_RELEASE_MANIFEST) right after it authenticates; while that attestation is refused -- the release is not registered at the key server's code-signing level, the level was raised under it, or the installed files no longer match the signed manifest -- every route but GET /api/health and GET /api/ready answers this, and detail names the cause. It is never a 401 or a 403: no credential or role of the caller's is at fault. The Gateway re-attempts on a timer and recovers without a restart once the key server admits it; GET /api/ready says when.