roles

List roles

List all roles available for use Access policy: administrator

get/roles

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/roles
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Response

Success

AuthorizationsPortainerAuthorizations
Descriptionstring

Role description

Idinteger

Role Identifier

Namestring

Role name

Priorityinteger

Example response

[
  {
    "Description": "Read-only access of all resources in an environment(endpoint)",
    "Id": 1,
    "Name": "HelpDesk"
  }
]

Changes

No recorded changes to this operation across all 21 revisions of this API.