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 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
• 403
• 409

---

roleWithVersionSchema

application/json

Schema

Schema

• version integer required

  Possible values: >= 1

  The version of this schema

• roles objectrequired

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

  id integer required

  The role id

  type string required

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

  name string required

  The name of the role

  description string

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

  project string nullable

  What project the role belongs to

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

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

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

• 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": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

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

• 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": "NameExistsError",
  "message": "There is already a feature called \"my-awesome-feature\"."
}

Loading...