AimableDocs
DocsAPI ReferenceRelease Notes
PATCH/v1/admin/principals/{principal_id}

Update Admin Principal

Path Parameters

NameTypeRequiredDescription
principal_idstring (uuid)Required

Headers

NameTypeRequiredDescription
X-API-KeystringOptional

Request Body

application/jsonRequired
statusobject
rolesobject
is_platform_adminobject
Authentication
X-API-Key: ak.<key_id>.<secret>Authentication & errors →

Request

curl -X PATCH '/api/v1/admin/principals/{principal_id}' \
  -H 'X-API-Key: ak.<key_id>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": {},
  "roles": {},
  "is_platform_admin": {}
}'

Response

200

No response body documented

Error Responses