Skip to main content

Get a list of roles

GET /api/admin/roles

Get a list of project, root and custom roles for Role-Based Access Control




  • version integer required

    Possible values: >= 1

    The version of this schema

  • 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

  • ]