Create an account

Request

To create an account, send a POST request to:

http://<host>:<port>/adm/v1/accounts/


An account ID (_id ) is assigned automatically when making this request. However, it is possible to explicitly set the value of this field. (For example, you may need to use the account ID from your CRM system.)

If you do this, you must not use Personally Identifiable Information (PII) (for example, an email address) as the value.

Headers

• Content-Type: application/json

Mandatory fields

• signonId 

  

  If you are creating accounts in OPF as (or on behalf of) an umbrella tenant, you must use the customer’s email address as the signOnId to ensure uniqueness across the shared OpenTV Video Platform instance.

• password 

Example

A request with this payload creates an account:

{
    "signonId": "CRM_ID1",
    "password": "password"
}

Response

See Account and Device Manager (ADM) API documentation.

Example

The payload of a response to a successful request looks like this:

{
    "_id": "5b7e71658ce5cb0001d85d18"
}

See also

For full details of this API, see Account and Device Manager (ADM) API documentation.