Device Registration

Introduction

Vimond Device Registration is a service for managing the user’s devices. You can add different rule sets that define the restrictions regarding device usage, and the service will enforce these rules when prompted to register a new device.

Rule Set

A rule set is what determines whether a device will be approved or denied. The rule set defines the following:

1. A start-stop interval for when the rule set should apply
2. Maximum number of active devices per user
3. The duration a usage record is locked after deleting a device

A rule set has the following model:

{
  ruleSetName: "default", // Identifier and name of ruleset
  validForInterval: "1519862461000-29353104061000", // Interval ruleset applies
  usageRestrictions: {
    maxDevices: 5, // Maximum number of devices per user allowed
    lockTime: 30 // Minimum time in days from one deletion to the next
  }
}

🚧 Configuring device rule sets

If you want to configure different device rules, please contact Vimond Support.

Device

A device has the following information:

{
          "label": "My iPhone",
          "udid": "eb840180-4c23-11e8-842f-0ed5f89f718b",
          "lastUsed": "2020-10-28T09:02:02.292Z",
          "state": "ACTIVE",
          "initializationDate": "2020-10-28T09:02:02.287Z",
          "lastDeletion": "1970-01-01T00:00:00.000Z"
        }

Usage Record

A usage record represents all devices a user has registered for a given rule set. It also contains other useful information. See the Usage Record - Endpoints.

See below for a model of a usage record:

{
  "devices": [
    {
      "label": "My iPhone",
      "udid": "eb840180-4c23-11e8-842f-0ed5f89f718b",
      "lastUsed": "2020-10-28T09:02:02.292Z",
      "state": "ACTIVE",
      "initializationDate": "2020-10-28T09:02:02.287Z",
      "lastDeletion": "1970-01-01T00:00:00.000Z"
    }
  ],
  "lastDeletion": "1970-01-01T00:00:00.000Z",
  "ruleSetName": "default",
  "deviceUsageRestrictions": {
    "lockTime": 2592000000,
    "maxDevices": 5
  },
  "nextDeletion": "1970-01-31T00:00:00.000Z",
  "numActiveDevices": 1,
  "numDevices": 1
}

Device registration and play call

When a play call is done, if the asset is linked to a device rule, then a call will be done to the device registration service. During this call, we will verify that the device given by the end user matches the rules set. If the user has already too many registered devices, then the play service will return an error response.

📘 Device usage update

Note that when a play call is done, we update the last update time. However only if the previous update time was done less than 6 hours ago.