admin

Issue Password Link

Changed on

Give an account a single-use link that sets its password, for someone who cannot sign in.

Where this deployment can mail links, the link goes to the account's address and is not returned, the same as "Forgot your password?". Where it cannot, or the send fails, the response carries the link for you to pass on, which is how a member who forgot their password gets back in on a deployment without mail. A password chosen through a link that was not mailed records the address as vouched for rather than proven. A new link replaces any earlier reset link for the account.

Refused with 409 for a deactivated account, one with no address, one that has no password and signs in with a provider or a passkey (its owner adds a password once signed in), and, where open_signup is disabled, an unverified address no organization still has as a member or invitee.

post/api/v1/admin/users/{user_id}/password-link

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

user_idstring uuid required

Response

Successful Response

expires_atstring date-time required

When the link stops working.

linkstring nullable

The link to pass on to the account's owner yourself, set only when mail_sent is false. Choosing a password through it records the address as vouched for rather than proven, since the mailbox never saw the link.

mail_sentboolean required

Whether the link was mailed to the account's address. False when this deployment cannot mail links, or the send failed.

Changes