Skip to main content

Validate a role

POST /api/admin/roles/validate

Check if the role matches schema and has a unique name

Request

Body

required

createRoleWithPermissionsSchema

  • name string required

    The name of the custom role

  • description string

    A more detailed description of the custom role and what use it's intended for

  • type string

    Possible values: [root-custom, custom]

    A custom role can either be a global/root custom role (applies to all projects) or a project custom role

  • permissions object[]

    A list of permissions assigned to this role

  • Array [
  • id number required

    The id of the permission

  • environment string

    The environments of the permission if the permission is environment specific

  • ]
Responses

This response has no body.

Loading...