v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
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

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