Recovering an account (third-party products)

Overview

If required, the CRM system can recover a user’s account.

The request described below returns an activation URL. This launches the third-party service’s portal with a short-lived token that allows the user to set up their account there. It is up to the CRM system as to how this is displayed or communicated to the user.

Request

To recover a user’s account, the CRM system should send a POST request to:

BASH

https://<host>:<port>/tpes/v1/operator/entitlements/{entitlementId}/actions/recover

Headers

x-correlation-id – identifier for logging, to correlate messages across a call flow
Authorization – Keycloak access token (see Accessing operator APIs using Keycloak)
Content-Type: application/json

Mandatory arguments

entitlementId – the ID of the entitlement to be recovered

Optional arguments

None

Response

A successful request returns an HTTP 200 status.

A bad request returns an HTTP 400 status.

If the specified entitlement does not exist, the request returns an HTTP 404 status.

Example

A successful request returns a response that looks like this:

JSON

{
  "recoveryUrl": "https://example.activation.url.bango.com"
}