admins

Update admin

Updates an existing admin. Recovery codes and TOTP configuration cannot be set/updated using this API: each admin must use the specific APIs. You are not allowed to update the admin impersonated using an API key

put/admins/{username}

Request

Base URL
/api/v2 (relative, and the document was published on a file host, not at the API’s origin)
Auth
- HTTP bearer
- or API key in header X-SFTPGO-API-KEY
TypeScript
https://skmtc.dev/kanton-bern/apis/sftpgo/docs/admins/:username/put.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idinteger

status0 | 1

status:

0 user is disabled, login is not allowed
1 user is enabled

usernamestring

username is unique

descriptionstring

optional description, for example the admin full name

passwordstring password

Admin password. For security reasons this field is omitted when you search/get admins

emailstring email

permissionsAdminPermissions[]

additional_infostring

Free form text field

created_atinteger

creation time as unix timestamp in milliseconds. It will be 0 for admins created before v2.2.0

updated_atinteger

last update time as unix timestamp in milliseconds

last_logininteger

Last user login as unix timestamp in milliseconds. It is saved at most once every 10 minutes

rolestring

If set the admin can only administer users with the same role. Role admins cannot have the "*" permission

Example request

{
  "filters": {
    "allow_list": [
      "192.0.2.0/24",
      "2001:db8::/32"
    ]
  }
}

Response

successful operation

messagestring

message, can be empty

errorstring

error description if any

Changes

No recorded changes to this operation across all 1 revision of this API.