Skip to navigation

Set User Platform Role

Grant, change, or revoke a user’s platform role (Super Admin only).

Previously the only way to do this was a direct database write - this is the self-service replacement. A platform admin cannot change their own role here (must be done by another Super Admin), so nobody can accidentally lock themselves out or silently self-escalate.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

user_idstringRequiredformat: "uuid"

Request

This endpoint expects an object.
platform_rolestring or nullOptional

Response

Successful Response
idstringformat: "uuid"
emailstring
is_activeboolean
first_namestring or nullOptional
last_namestring or nullOptional
tenant_idstring or nullOptionalformat: "uuid"
tenant_namestring or nullOptional
tenant_slugstring or nullOptional
platform_rolestring or nullOptional
created_atstring or nullOptional

Errors

422
Unprocessable Entity Error