Cancelling an account

Request

To cancel an account, the CRM should send a PUT request to:

https://<host>:<port>/adm/v1/accounts/preHashedPassword/{uid}

In deployments that use NAGRA's Security Services Platform (SSP), this request must be made twice – once to OPF, and once to SSP.

The URLs of the two endpoints will be provided to you by NAGRA.

Cancelling an account is permanent. To disable an account so that it can be reactivated, suspend it instead.

Headers

• x-correlation-id – identifier for logging, to correlate messages across a call flow

• Authorization – bearer token obtained in Getting an access token

• nv-tenant-id – the tenant ID

• Content-Type: application/json

Mandatory arguments

All the following arguments are in the request body:

• uid – the account’s unique ID (in the URL)

• status – for this use case, the value must be CANCELLED.

Other arguments

See /accounts/preHashedPassword/{uid} in the ADM API documentation.

Response

A successful request returns an HTTP 201 status.

A bad request returns an HTTP 400 status.

A request with an invalid token returns an HTTP 403 status.

If the tenant or account does not exist, the request returns an HTTP 404 status.

Example

A successful request returns s response that looks like this:

{
  "matchedCount": 1,
  "modifiedCount": 1
}

See also

For full details of this API, see the ADM API documentation.