User data model
Name | Type | Description | Qualifier | Localised | Always available |
|---|---|---|---|---|---|
account | AccountSpecification | Identifies the account associated with the user. | RW, mandatory | No | Yes |
dateOfBirth | Date | The date of birth of the user, in the format | RW, optional | No | No |
defaultUser | Boolean | Is this the default user for the associated account? Each account must have one default user. | WriteOnCreate, optional | No | No |
hashSalt | String (max 100 chars) | Salt value used to encrypt the password in the DB. If this field is blank, the password is stored in clear text. | WriteOnCreate, optional | No | No |
loginId | String (max 100 chars) | Unique ID that the client uses to identify the user at signon. Mandatory when creating OpenTV Player clients. If this field has a value, it must be unique across all users | WriteOnCreate, mandatory | No | Yes |
name | String (max 20 chars) | Friendly name. Used in addition to loginID to identify the user. | RW, mandatory | No | Yes |
originId | String | Identifier of the system which owns this entity. | WriteOnCreate, optional | No | No |
originKey | String (max 20 chars) | External user identifier. | WriteOnCreate, optional | No | No |
password | String (max 100 chars) | Password used to sign on. Mandatory when creating OpenTV Player clients. | RW, optional | No | No |
pin | String (max 10 chars) | PIN to access restricted content. | RW, mandatory | No | Yes |
purchaseAbility | String | Keyword indicating if this user is permitted to make purchases.
Super-users can modify this flag for other users in the account. | RW, optional | No | No |
ratingSpecification | RatingSpecification | Identifies a rating to assign to the user. | RW, optional | No | No |
type | String | The type of the user. One of:
At least one user in the account must be | RW | No | No |
uid | Long | Internal numeric identifier. The SDP internal UID for this entity. | RO, assigned internally | No | Yes |