Endpoint /admin/users/{username}/password

POST https://example.com/admin/users/{username}/password

POST

Updates the password of the given username with a new password.

Examples

This sample changes the admin password to a new given password.

HTTP

# Request:
curl --location --request POST 'https://trial.dsserver.io/admin/users/admin/password' \
    --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
    --header 'Content-Type: application/json' \
    --data-raw '{
            "newPassword": "newpassword"
        }'

Authorization

This endpoint supports the Basic authorization method:

Basic

Header Field	Description
Authorization	The username "admin" and your admin password are combined into a string separated by a colon, e.g.: admin:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example: Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

Request Payload

Type	Value
AdminPasswordUpdate	The AdminPasswordUpdate object contains the new password.

AdminPasswordUpdate

Name	Type	Value	Optional
newPassword	String	The new password. Minimum character length is 8.	no

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK).

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
400	A 400 (Bad Request) is returned, if the password could not be updated or the password doesn´t fulfil the minimum requirements. Minimum length is 8 characters.