Create a new user. 

Version: v4

Required Permissions

The authenticated user must be an admin.

Request

Request Type: POST

Endpoint:

/v4/passwordresetrequest/

 

Request Body:

The following properties are supported:

{
  "accountId": 6,
  "email": "joe@example.com",
  "orginURL": "http://loginpage.example.com:3005/"
}

Response

Response Status Code - Success:  201 - Created

Response Body Example:

{
    "code": "<AccountResetURL>",
    "email": "joe@example.com"
}

Reference

Request properties:

PropertyDescription
accountIdInternal identifier of the user whose password should be reset
emailThe email address to which to deliver the password reset email. This value should correspond to the login for the specified account. For more information, see API People Get v4.
originURL

The URL of the login page for the

Response properties:

PropertyDescription
code

The password reset code generated for the specified user.

NOTE: This endpoint does not generate an email or perform the reset. You must use the reset code to build a reset URL to send separately to the specific user. See below.

The above must be built into a URL in the following format:

<http|https>://<host_name>:<port_number>/password-reset?email=<user_id>&code=<AccountResetCode>
URL elementExample valueDescription
<http|https>
httpHTTP protocol type
<host_name>
loginpage.example.com

Host of the

<port_number>
3005

Port number used to login to the

<user_id>
joe@example.comUser ID (email address) of the user whose password is to be reset
<AccountResetCode>
CD44232791Password reset code

For more information, see API Overview.