Reset password

When a password reset is requested, an email with a token is sent. Upon receiving the email the user then needs to click a link and choose a new password.

Request password reset

Sends an email with a link containing a token to reset user password.

Request
Security:
Request Body schema: application/json

Forgot password resource.

email
required
string <email>

Email.

Responses
204

Email sent successfully.

422

Invalid data was sent.

post/forgot-password
Request samples
application/json
{
  • "email": "user@example.com"
}
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string",
  • "invalidFields": [
    ]
}

Read token information

Request
Security:
path Parameters
token
required
string

The token string.

Responses
200

Token was retrieved successfully.

404

Resource was not found.

get/reset-password/{token}
Request samples
curl -i -X GET \
  https://api-sandbox.rebilly.com/organizations/unknown/reset-password/:token \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "token": "string",
  • "sentTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Finish password reset

Reset user password.

Request
Security:
path Parameters
token
required
string

The token string.

Request Body schema: application/json

ResetPassword resource.

newPassword
required
string <password>

New password.

Responses
201

Password was reseted successfully.

422

Invalid data was sent.

post/reset-password/{token}
Request samples
application/json
{
  • "newPassword": "pa$$word"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "businessPhone": "string",
  • "mobilePhone": "string",
  • "password": "pa$$word",
  • "permissions": [
    ],
  • "computedPermissions": [
    ],
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "loginTime": "2019-08-24T14:15:22Z",
  • "reportingCurrency": "string",
  • "availableCurrencies": [
    ],
  • "totpRequired": true,
  • "totpSecret": "string",
  • "totpUrl": "string",
  • "status": "active",
  • "country": "string",
  • "preferences": { },
  • "roleIds": [
    ],
  • "allowedIps": [
    ],
  • "_links": [
    ]
}