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

    anyOf
  • 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]

    Custom root roles (type=root-custom) are root roles with a custom set of permissions. Custom project roles (type=custom) contain a specific set of permissions for project resources.

  • permissions object[]

    A list of permissions assigned to this role

  • Array [
  • name string required

    The name of the permission

  • environment string

    The environments of the permission if the permission is environment specific

  • ]
Responses

This response has no body.

Loading...