Users

Redeem invite

Changed on

Redeem an invite token, set password, and return a JWT.

post/users:redeem-invite

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /users:redeem-invite
  • Auth: none required

Request body

invite_tokenstring required

The invite token issued when the user was created or re-invited.

passwordstring required

Password to set for the invited user.

Example request

{
  "invite_token": "dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk",
  "password": "example-password"
}

Response

Successful Response

access_tokenstring required

Signed JWT to send as a bearer token on subsequent requests.

expires_ininteger required

Lifetime of the access token in seconds.

must_change_passwordboolean required

Whether the user must change their password before using other endpoints.

token_typestring required

Token type; always bearer.

Example response

{
  "access_token": "example-access-token",
  "expires_in": 3600,
  "must_change_password": false,
  "token_type": "bearer"
}

Changes