Users

Update a user

POST/api/users/{userId}

Updates a user's password. Administrators can also change the username and role.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
userIdrequired	string	ID of the associated user.

Request body

Name	Type	Description
password	string	Password used to authenticate the account.
role	enum<string>	Permission role assigned to the user. Options: `admin`, `user`, `view-only`
username	string	Username of the account.

Example request

{
  "password": "string",
  "role": "admin",
  "username": "string"
}

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
idrequired	string	Unique identifier of the resource.
rolerequired	string	Permission role assigned to the user.
usernamerequired	string	Username of the account.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "id": "string",
  "role": "string",
  "username": "string"
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

404Not found.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

404 example

{
  "error": {
    "code": "not-found",
    "message": "Not found.",
    "status": 404
  }
}

Code samples

cURL

curl -X POST 'https://api.example.com/api/users/{userId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "password": "string",
  "role": "admin",
  "username": "string"
}'

PreviousList a user's websites NextList websites