Skip to main content
PUT
Update a principal

Authorizations

x-api-key
string
header
required

Path Parameters

user_id
string
required

Body

application/json

The update-principal request body: display name and/or disabled, both omit-means-keep.

disabled
boolean | null
display_name
string | null
Minimum string length: 1

Response

Success.

data
Principal · object
required

A principal: the unit of identity and authority every credential belongs to.

user_id is the id the access-control policy row is keyed by. kind is human (authenticates through an accounts provider) or service (holds keys only, never logs in interactively). display_name is the operator- facing label. created_by is the principal id that created this one, or None for the owner the setup door mints. disabled turns off every credential the principal owns. created_at is timezone-aware (UTC).