Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0641

D s api version

D toc

Create a new user. 

Version: v4

Required Permissions

The authenticated user must be an admin.

D s api auth

Request

Request Type: POST

Endpoint:

Code Block
/v4/passwordresetrequest/

 

Request Body:

The following properties are supported:

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

Response

Response Status Code - Success:  201 - Created

Response Body Example:

Code Block
{
    "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

D s webapp

Response properties:

PropertyDescription
code

The password reset code generated for the specified user.

Info

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. For more information, see CLI Migration to APIs.