Skip to Content
OpenETL
ReferenceAPIAccess Service

Create password link

A one-use link for a user to set their password, which replaces the user's previous link. The user needs an email to sign in with.

POST
/v1/principals/{principal}:passwordLink

A one-use link for a user to set their password, which replaces the user's previous link. The user needs an email to sign in with.

Path Parameters

principal*string

The principal id.

Request Body

application/json
  1. body
name?string

principals/{principal}

expireTime?string

Unset: in 24 hours. At most 7 days ahead.

Formatdate-time

Response Body

OK

application/json
  1. response
url?string

{public URL}/set-password#{token}. The API never returns it again.

expireTime?string
Formatdate-time
Example Request
curl -X POST 'http://localhost:8080/v1/principals/string:passwordLink' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "url": "string",  "expireTime": "2019-08-24T14:15:22Z"}