Get roles for currently logged in user

GET /api/admin/user/roles

Gets roles assigned to currently logged in user. Both explicitly and transitively through group memberships

Request

Query Parameters

• projectId string

  The id of the project you want to check permissions for

Responses

• 200
• 401
• 403

---

rolesSchema

application/json

Schema

Schema

• version integer required

  Possible values: >= 1

  The version of the role schema used

• roles object[]required

  A list of roles

  Array [

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

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

Loading...