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 stringrequired

The name of the custom role

Example: external-contributors

description string

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

Example: Users with external-contributors role have limited access to most features in Unleash

type string

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.

Possible values: [root-custom, custom]

Example: root-custom

permissions

object[]

A list of permissions assigned to this role

Array [

name stringrequired

The name of the permission

Example: CREATE_PROJECT

environment string

The environments of the permission if the permission is environment specific

Example: development

]

MOD2

name stringrequired

The name of the custom role

Example: external-contributors

description string

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

Example: Users with external-contributors role have limited access to most features in Unleash

type string

Custom project roles contain a specific set of permissions for project resources.

Possible values: [custom]

Example: custom

permissions

object[]

A list of permissions assigned to this role

Array [

id numberrequired

The id of the permission

Example: 2

name string

The name of the permission

Example: CREATE_PROJECT

environment string

The environments of the permission if the permission is environment specific

Example: development

]

Responses

200

This response has no body.

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

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 []."
}

401

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

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...