Get a single role

GET <your-unleash-url>/api/admin/roles/:roleId

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Get a single role by role id

Request

Path Parameters

• roleId string required

Responses

• 200
• 400
• 401
• 404

---

roleWithPermissionsSchema

application/json

Schema

Schema

• id number required

  The role id

• type string required

  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

• name string required

  The name of the role

• description string

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

• permissions object[]required

  A list of permissions assigned to this role

  Array [

  id integer required

  The identifier for this permission

  name string required

  The name of this permission

  displayName string required

  The name to display in listings of permissions

  type string required

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

  environment string

  Which environment this permission applies to

  ]

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

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 requested resource was not found.

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": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

roleId — path required

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/roles/:roleId' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'