User Create

Customers and distributor's staff can create and attach users to your service through ActivePlatform. The User Create notification URL allows the vendor service to receive notifications when a user was attached to the service.

The general flow for the User Create event includes the following steps:

A new user is attached to the vendor service via ActivePlatform.
ActivePlatform calls the configured notification URL, passing the JSON with user details.
The vendor service validates the request, creates the user, returns the user ID or provides details about the occurred error.
ActivePlatform completes the user attachment.

POST /user/create?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 subscription of the service plan through the ActivePlatform installation

Event body

Name	Data type	Description
password	string	Initial user password
email	string	User email used as a login
first_name	string	First name of the user
last_name	string	Last name of the user

Response

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

201 HTTP code status.
JSON with the following information:

Name	Data type	Description
id	string	User ID generated in the vendor service

If a user was not created, the vendor service returns:

HTTP code status.
JSON with the following information:

Name		Data type	Description
task		object
	error_message	string	Text message of the occurred error

Event example

POST http://example.com/user/create

{
	"password":"password",
	"email":"john.doe@examaple.com",
	"first_name":"John",
	"last_name":"Doe"
}

Response example

HTTP code: 201 created

{
 "id": "1234567"
}