Skip to navigation

Rename or disable/enable a principal

API key required. Rename (same naming rules as create), disable, or enable a live principal. Disabling is instant: every key of the principal gets DENY on its next check until re-enabled. Renames never rewrite history — receipts snapshot the principal name at write time. Writes a PRINCIPAL_UPDATE receipt when anything changes.

Path parameters

principalIdstringRequired

Request

This endpoint expects an object.
namestringOptional
New directory name.
disabledbooleanOptional

true disables, false re-enables.

Response

The updated principal.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error