user APIs

Update user profile

Allows to update the profile for the logged in user

put/user/profile

Request

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

Request body

emailstring email

descriptionstring

allow_api_key_authboolean

If enabled, you can impersonate this user, in REST API, using an API key. If disabled user credentials are required for impersonation

public_keysstring[]

Example request

{
  "public_keys": [
    "ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBEUWwDwEWhTbF0MqAsp/oXK1HR2cElhM8oo1uVmL3ZeDKDiTm4ljMr92wfTgIGDqIoxmVqgYIkAOAhuykAVWBzc= user@host"
  ]
}

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.