PUT /api/roles/{id}

Rename a role, replace its operation set, or both.

GET_ROLES, UPDATE_ROLE, then GET_ROLES to read back: saved is true only when each field SENT reads back -- the name, and the operation set compared as a set.

operations REPLACES the role's whole operation set (an empty array removes every operation); omit it to rename only. Omit name to edit operations only. The change reaches every principal holding the role, and nothing here reports which ones.

A built-in (SYSTEM_DEFINED) role is read-only and is refused before anything is written.

Role: Administrator.

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
id	path	yes	string	The role id, as GET /api/roles lists it.

Request

Field	Type	Required	Description
name	string	no
operations	array of string	no	The complete new set, as ids from GET /api/operations.

Example

{
  "name": "...",
  "operations": [
    "..."
  ]
}

Responses

200

Updated, and read back.

Field	Type	Required	Description
id	string	yes
requested	string	no	Present when name was sent.
requestedOperations	array of string	no	Present when operations was sent.
saved	boolean	yes
missing	boolean	no
role	object or null	no

role object

Field	Type	Required	Description
id	string	no
name	string	no
operations	array of string	no

Example

{
  "id": "...",
  "requested": "...",
  "requestedOperations": [
    "..."
  ],
  "saved": true,
  "missing": true,
  "role": {
    "id": "...",
    "name": "...",
    "operations": [
      "..."
    ]
  }
}

400

BAD_REQUEST -- a malformed id, an empty name, operations not an array of 16-hex-digit ids, or neither field given.

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

BUILT_IN -- the role is SYSTEM_DEFINED and read-only; decided before anything is sent. Or ACCESS_DENIED -- the key server refused UPDATE_ROLE to the caller.

404

NOT_FOUND -- no role has that id.

409

The update was accepted and a field sent does not read back. The 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.

Status	Meaning
400	BAD_REQUEST -- a malformed id, an empty name, operations not an array of 16-hex-digit ids, or neither field given.
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	BUILT_IN -- the role is SYSTEM_DEFINED and read-only; decided before anything is sent. Or ACCESS_DENIED -- the key server refused UPDATE_ROLE to the caller.
404	NOT_FOUND -- no role has that id.
409	The update was accepted and a field sent does not read back. The 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.