API Password Reset Request Create v4

Contents:

Expand all Collapse all

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

This is the latest version of the APIs.

Contents:

Create a new user.

Version: v4

Required Permissions

The authenticated user must be an admin.

NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.

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 Status Code - Success: 201 - Created

Response Body Example:

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

Request properties:

Property	Description
accountId	Internal identifier of the user whose password should be reset
email	The 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 Designer Cloud application

Response properties:

Property	Description
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 element	Example value	Description
<http\|https>	`http`	HTTP protocol type
<host_name>	loginpage.example.com	Host of the Designer Cloud application
<port_number>	`3005`	Port number used to login to the Designer Cloud application
<user_id>	`joe@example.com`	User ID (email address) of the user whose password is to be reset
<AccountResetCode>	`CD44232791`	Password reset code

For more information, see API Overview.