Cloud Administration Password Reset Code API

Use the Cloud Administration Password Reset Code API to generate password reset codes for a set of users.

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration APIs.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to generate a password code for a user.

Example Request Data

The following example displays a request.

POST /AdminInterface/restapi/v1/users/generateVerifyCode/resetPassword

Accept: application/json

Authorization: Bearer <JWT token>

Request Body Parameters

The following table describes the request body parameters.

Example Request Body

The following is an example request body.

[{
        "email": "user1@example.com",
        "code_validity": "10",
        "validity_time_duration_unit": "MIN"
    }, {
        "email": "user2@example.com",
        "custom_email": "alternate1@example.com",
        "code_validity": "5",
        "validity_time_duration_unit": "HOUR",
        "code_send_to": "EMAIL"
    }
]

Note:  Password reset codes will be emailed to the designated user if the generation request includes the "code_send_to" parameter set to "EMAIL" for that user. You can specify an alternate email address in the request parameters if you want the reset code to be sent to that alternate email instead.

Response Body Parameters

The following table describes the response body parameters.

Example Response Body

The following example response shows password reset code for all users when generated successfully.

[
    [{
            "status": 1000,
            "errorMessage": "Code Successfully Generated. ",
            "userDetailsRequestForVerifyCodeGeneration": {
                "email": "user1@example.com",
                "code_validity": "10",
                "validity_time_duration_unit": "MIN",
                "code_send_to": "DISPLAY"
            },
            "verify_code": "123456789",
            "verify_code_validity_time": "2024-07-01 11:24:50 UTC",
            "verify_code_generation_mode": "PASSWORD_RESET",
            "verification_Link": "https://example-admin.com/resetPassword/admin"
        }
    ]

Note:  The response from the generate request will show whether the email delivery was successful. A status code of 1000 indicates that the email was sent successfully, whereas a status code of 1005 signifies an error occurred while attempting to send the email.

Response Codes

The following table shows response codes and descriptions for this API.