User Delete
Customers and distributor's staff can detach users from a vendor service through ActivePlatform. The User Delete notification URL allows a vendor service to receive notices when a user is detached.
The general flow for the User Delete event includes the following steps:
- A user was detached through ActivePlatform.
- ActivePlatform calls the configured notification URL, passing the JSON with the user ID.
- The vendor service validates the request, deletes the user, confirms the operation or returns the details about the occurred error.
- ActivePlatform completes the operation with the user.
POST /user/delete?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_id | query | string | Reseller 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 deleted, the vendor service returns:
- 200 HTTP code status.
If a user was not deleted, the vendor service returns HTTP code and error message.
- HTTP code status.
- JSON with the following information:
Name | Data type | Description | |
|---|---|---|---|
| task | object | ||
| error_message | string | The text message of the occurred error | |
Event example
POST http://example.com/user/delete{
"id": "1234567"
}Response example
The user was successfully deleted:
- HTTP code status: 200 OK