Change Password

Change Password

POST

/api/portal/v1/user/passwordChange

Description

Change the password of the user associated with the bearer token used for the request. Existing session tokens for the user remain valid until they are explicitly invalidated through the logout endpoint.

Authentication

This endpoint requires a Bearer token in the Authorization header.

  • Authorization: Bearer <token>. A valid Portal API session token or API token.

Request Body

The request body should be JSON-encoded.

  • password: The new password. Must be at least 4 characters long.

Response

On success, the endpoint returns a 204 No Content response with an empty body.

Error Responses

  • 400 Bad Request: The password field is missing, or the supplied password is too short.
  • 401 Unauthorized: The Authorization header is missing or the token is not valid.
Example Request
POST https://<your-host>:9909/api/portal/v1/user/passwordChange
Authorization: Bearer <token>
Content-Type: application/json

{
    "password": "new-strong-password"
}

Example Response
Status Code: 204 No Content
VectorCharts.com © 2024, Zydro Marine Technologies, Inc. · vectorcharts.com