VoiceGateway

Make a password reset link for a member

POST
/api/v1/org/{orgId}/members/{userId}/password-reset

Authorization

consoleSession
cookievg_session<token>

The console's session cookie, set when you sign in. Every operation accepts it, at the role the operation names.

Path Parameters

orgId*string

Authorised orgId; the server must verify organisation/project ownership before any read.

Length1 <= length
userId*string

A member's user id; one outside the named organisation is not_found.

Length1 <= length

Response Body

The reset link's expiry, and the link when SMTP is not set.

application/json
  1. response
link*|
Formaturi
expiresAt*string

When the link stops working, 24 hours after it was made.

Formatdate-time
emailed*boolean

True when the email was sent; false without SMTP, or when the send failed.

Example Request
curl -X POST 'https://example.com/api/v1/org/string/members/string/password-reset'
Example Response
{  "link": "http://example.com",  "expiresAt": "2019-08-24T14:15:22Z",  "emailed": true}

Was this page helpful?