Validate a role

POST /api/admin/roles/validate

Check if the role matches schema and has a unique name

Request

application/json

Body

required

createRoleWithPermissionsSchema

anyOf
MOD1
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
]
MOD2
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: [custom]
Custom project roles contain a specific set of permissions for project resources.
permissions object[]
A list of permissions assigned to this role
Array [
id number required
The id of the permission
name string
The name of the permission
environment string
The environments of the permission if the permission is environment specific
]

Responses

• 200
• 400
• 401

---

This response has no body.

The request data does not match what we expect.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

Loading...