Create a new role

POST 
/api/admin/roles

Create a new custom role for Role-Based Access Control

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

roleWithVersionSchema

application/json

Schema

Schema

version integerrequired
The version of this schema
Possible values: >= 1
Example: 1

roles

object

required

A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform

id integerrequired

The role id

Example: 9

type stringrequired

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

Example: root

name stringrequired

The name of the role

Example: Editor

description string

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

Example: Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.

project stringnullable

What project the role belongs to

Example: default

Example (from schema)

{
  "version": 1,
  "roles": {
    "id": 9,
    "type": "root",
    "name": "Editor",
    "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
    "project": "default"
  }
}

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

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

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: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

409

The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively.

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: NameExistsError
message string
A description of what went wrong.
Example: There is already a feature called "my-awesome-feature".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

Loading...