Activating a TVkey device for a specific account (multiple OPF accounts scenario)

Request

To activate a TVkey device and associate it to a specific account in OPF (when multiple accounts exist for a single SSO account, that is, the response when Activating a TVkey device with SSO was an HTTP 300 status), send a POST request to:

CODE

https://<host>:<port>/ags/subsequentRegister

Headers

User-Token – the userAccountToken that is available to both the TVkey installer and supervisor apps (mandatory)
x-correlation-id – identifier for logging, to correlate messages across a call flow
x-auth-service-id – the ID of the authentication (SSO) service to be used for authentication (mandatory)
nv-tenant-id – the tenant ID

Mandatory arguments

User-Token – (in header) – see above
x-auth-service-id – (in header) – see above
parameters – an array of parameters. These are defined in the response to the GET /servicediscovery request.
Each member of the array is a key/value pair in the following form:
CODE
```
{
  "parameters": [
    {
      "name": "<name>",
      "value": "<value>"
    }
  ]
}
```

Other arguments

None

Example

A POST request with this payload activates the TVkey device and associates it to the selected OPF account:

CODE

{
  "parameters": [
    {
      "name": "username",
      "value": "dave"
    }
  ]
}

Note that the contents of the parameters block depend on the requirements of the SSO provider.

Response

A successful request returns an HTTP 201 status.

A bad request returns an HTTP 400 status.

An unauthorised request returns an HTTP 401 status.

A forbidden request returns an HTTP 403 status.