Get a single role

GET 
/api/admin/roles/:roleId

Get a single role by role id

Request

Path Parameters

roleId stringrequired

Responses

200

roleWithPermissionsSchema

application/json

Schema

Schema

id numberrequired
The role id
Example: 9
type stringrequired
A role can either be a global root role, or a project role or a custom project role or a custom global root-custom 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.

permissions

object[]

required

A list of permissions assigned to this role

Array [

id integerrequired

The identifier for this permission

Example: 3

name stringrequired

The name of this permission

Example: UPDATE_FEATURE

displayName stringrequired

The name to display in listings of permissions

Example: Update feature flags

type stringrequired

What level this permission applies to. Either root, project or the name of the environment it applies to

Example: project

environment string

Which environment this permission applies to

Example: development

]

Example (from schema)

{
  "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.",
  "permissions": [
    {
      "id": 3,
      "name": "UPDATE_FEATURE",
      "displayName": "Update feature flags",
      "type": "project",
      "environment": "development"
    }
  ]
}

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

404

The requested resource was not found.

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: NotFoundError
message string
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...