POST /api/keys/acl/get

Read a key's ACL.

Returns the ACL of the key named by ttag, as the key server currently holds it.

WARNING: rights masks are WIDENED by the key server, so an entry may carry bits nobody asked for -- READ accompanies WRITE, and an owner entry carries more still. Test them with a mask AND, never with equality.

Principal ids come back as DECIMAL STRINGS and feed straight back into the grant, update and revoke routes and into POST /api/keys/export. ACL and entry ids are opaque base64 handles. Access-window stamps are base64 of the raw 8-byte value, with startTimeUnset / endTimeUnset reporting the all-zero "no window" default rather than converting it into a date it does not mean.

WARNING: a 404 here does NOT mean the key is unknown. It means the key server resolved no ACL for that link. A hidden link naming no key on this server is read as naming a FOREIGN key and refused by the key server, which arrives as a 500.

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
ttag	string	yes	Canonical base64. Must decode to at least one byte.

Example

{
  "ttag": "..."
}

Responses

200

The ACL.

Field	Type	Required	Description
aclId	string	no
hiddenLink	object	no	The hidden link as the key server reports it on the ACL object. Its shape is the key server's and is passed through unchanged; do not depend on it. Use the ttag you sent.
expired	boolean	no
entryCount	integer	no
entries	array of AclEntry	no	One ACL entry -- one principal's rights over one key.
detail	string	no

Example

{
  "aclId": "...",
  "hiddenLink": {},
  "expired": true,
  "entryCount": 0,
  "entries": [
    {
      "principalId": "...",
      "systemId": 0,
      "aclEntryId": "...",
      "aclId": "...",
      "rights": 0,
      "rightNames": [
        "OWNER"
      ],
      "maxUsage": 0,
      "userRight": 0,
      "startTime": "...",
      "startTimeUnset": true,
      "endTime": "...",
      "endTimeUnset": true
    }
  ],
  "detail": "..."
}

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

OBJECT_NOT_IN_CREDENTIAL_SCOPE, or ACCESS_DENIED. Note the key server's own authorization for reading an ACL is role-gated as well as ACL-gated, and the two are separate checks.

404

ACL_NOT_FOUND -- no ACL resolved for that link. Nothing was modified. See the warning above about what this is not.

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	OBJECT_NOT_IN_CREDENTIAL_SCOPE, or ACCESS_DENIED. Note the key server's own authorization for reading an ACL is role-gated as well as ACL-gated, and the two are separate checks.
404	ACL_NOT_FOUND -- no ACL resolved for that link. Nothing was modified. See the warning above about what this is not.
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.