users

List users

List Portainer users. Non-administrator users will only be able to list other non-administrator user accounts. User passwords are filtered out, and should never be accessible. Access policy: restricted

get/users

Request

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

Query parameters

environmentIdinteger

Identifier of the environment(endpoint) that will be used to filter the authorized users

Response

Success

Idinteger required

User Identifier

Role0 | 1 | 2 required
TokenIssueAtinteger
UseCacheboolean
Usernamestring required

Example response

[
  {
    "Id": 1,
    "ThemeSettings": {
      "color": "dark"
    },
    "TokenIssueAt": 1,
    "UseCache": true,
    "Username": "bob"
  }
]

Changes

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