roles

Validate a role document

Changed on

Checks a role document, in JSON or YAML, without saving it, and lists every problem found with where it is, so an editor can mark each one. Pass id to check an edit to an existing role, so it keeping its own name is not reported as a clash.

post/api/v1/roles/validate

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Query parameters

idstring

ID of the role being edited

Request body

descriptionstring
namestring
permission_idsstring[]
permission_keysstring[]

PermissionKeys names permissions as resource_type:action keys, the form a hand-written role document uses.

Response

OK

validboolean

Changes