Password

Update password {#update-password}

PUT /v1/users/password

Replaces the password list of the specified user with a single new password. If a username is not provided in the JSON request body, it replaces the password list of the authenticated user making this request instead.

Request {#put-request}

Example HTTP request

PUT /v1/users/password

Example JSON body

{
    "username": "The username of the affected user. If missing, default to the authenticated user.",
    "new_password": "the new (single) password"
}

Request headers

Request body

The request must contain a JSON object with the following fields:

Response {#put-response}

Returns a status code to indicate password update success or failure.

Error codes {#put-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#put-status-codes}

Add password {#add-password}

POST /v1/users/password

Adds a new password to the specified user's password list. If a username is not provided in the JSON request body, it adds the password to the password list of the authenticated user making this request instead.

Request {#post-request}

Example HTTP request

POST /v1/users/password

Example JSON body

{
    "username": "The username of the affected user. If missing, default to the authenticated user.",
    "new_password": "a password to add"
}

Request headers

Request body

The request must contain a JSON object with the following fields:

Response {#post-response}

Returns a status code to indicate password creation success or failure. If an error occurs, the response body may include a more specific error code and message.

Error codes {#post-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#post-status-codes}

Delete password {#delete-password}

DELETE /v1/users/password

Deletes a password from the specified user's password list. If a username is not provided in the JSON request body, it deletes the password from the password list of the authenticated user making this request instead.

Request {#delete-request}

Example HTTP request

DELETE /v1/users/password

Example JSON body

{
    "username": "The username of the affected user. If missing, default to the authenticated user.",
    "old_password": "an existing password to delete"
}

Request headers

Request body

The request must contain a JSON object with the following fields:

Response {#delete-response}

Error codes {#delete-error-codes}

When errors are reported, the server may return a JSON object with error_code and message fields that provide additional information. The following are possible error_code values:

Status codes {#delete-status-codes}