POST /system-ms/email-server/v1

Reset or change the password.

To reset or change the password:
  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use POST /system-ms/email-server/v1 to send an HTTP POST request.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:
    {
      "userId": "string",
      "otp": 0,
      "password": "string"
    }
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description

    >userId

    String

    Enter the user ID.

    Format: Up to 30 alphanumerical characters. The characters ", *, ?, , &, ', <, > and comma (,) are not allowed.

    Example: johnsmith.

    Maximum Length: 30

    Minimum Length: 0

    Pattern: ^[^,'"\\&<>?*]*$

    Note: This parameter is mandatory.
    >otp

    String

    Enter the OTP.
    Note: This parameter is mandatory.
    >password

    String

    Enter the new password.
    Note: This parameter is mandatory.
  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/system-ms/email-server/v1
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    200 OK

    {
      "otp": 0,
      "userId": "string",
      "password": "string"
    }
    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable