User Password Reset

The user password can be reset manually or automatically through ActivePlatform. The User Password Reset notification URL allows a vendor service to receive notifications when the user password is changed.

The general flow for the User Password Reset event includes the following steps:

  • The user password is changed through ActivePlatform.
  • ActivePlatform calls the configured notification URL, passing the JSON with the user ID and new password.
  • The vendor service validates the request, resets the user, confirms the operation or returns the details about the occurred error.
  • ActivePlatform completes the operation with the user.
POST /user/password_reset?ap_guid={ap_guid}&reseller_id={reseller_id}

Arguments

Name

Parameter type

Data type

Description

ap_guid

query

string

Auto-generated installation GUID (Globally Unique Identifier). The ap_guid is used to identify the ActivePlatform installation that called the entry point
reseller_idquerystringReseller ID who sold the user of the service plan through the ActivePlatform installation

Event body

Name

Data type

Description

id

string

User ID generated in the vendor service

Response model

If a user was successfully reset, the vendor service returns:

  • 200 HTTP code status.

If a user was not reset, the vendor service returns HTTP code and error message.

  • HTTP code status.
  • JSON with the following information:

Name

Data type

Description

taskobject



error_messagestringText message of the occurred error

Event example

POST http://example.com/user/password_reset
{
	"id":"1234567",
	"password":"1234$Q3##E"
}

Response example

The user was successfully reset:

  • HTTP code status: 200 OK.