v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
users

Create a new user

Create a new Portainer user. Only administrators can create users. Access policy: restricted

post/users

Request body

Passwordstring required
Role1 | 2 required

User role (1 for administrator account and 2 for regular account)

Usernamestring required

Example request

{
  "Password": "cg9Wgky3",
  "Role": 2,
  "Username": "bob"
}

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