Skip to main content
GET
List assignable user roles

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Response

200 - application/json

OK

key
string
required

The value to send as role when you create or update a user.

display_name
string
required

The role's name, for display.

can_write
boolean
required

True for admin roles, which can make changes; false for reader roles, which can only view.