Subprofile Service

In a scenario where multiple individuals use the same end-user account, having distinct subprofiles proves beneficial for organizing users’ preferences. For example, within a family sharing an account, the father and daughter might have different interests, making it essential to store their playlists separately. Subprofiles provide an additional layer of abstraction that helps distinguish family members and their preferences effectively.

A subprofile comprises a nickname, a subProfileId, and optional data such as gender, age limit, and restrictions. Each person using the same account can have their own subprofile, where the subprofile ID can be specified during creation, or an auto-generated UUID will be assigned.

The Vimond Subprofile service facilitates subprofile management for users, supporting CRUD (Create-Read-Update-Delete) operations on subprofiles. Additionally, it offers an endpoint to retrieve a user subprofile JWT token, which can be supplied when calling other Vimond services like Video Playback, Playlist Service, etc. This token is sent in the X-Vimond-Subprofile header field to other services (for example Video Playback, Playlist service).

Subprofile Limit

By default, a user is allowed to have up to 5 subprofiles. For any changes to this limit, please contact your TAM (Technical Account Manager).

Subprofile Token

The user subprofile JWT token serves to identify a subprofile and does not replace the access token. Both tokens must be provided when accessing Vimond APIs.

Default Subprofile

If the subprofile token is not provided by the client, the request will be associated with the default subprofile.

Subprofile Model Example

{
  "subProfileName": "Michael",
  "subProfileId": "71d2aa8b-5ca8-4e99-b70c-a132f9bcef5f",
  "properties": {
    "ageLimit": "18",
    "gender": "M"
  }
}

Example Usage Flow

Events

Though not all services require the X-Vimond-SubProfile header and the subprofile token, it is possible to include them in all service requests. When operations are performed on Vimond services, they generate events. These events can be subsequently processed by the tenant directly.

Passing the subprofile token to all services (even those that do not explicitly require it) ensures that the subprofile ID is included in the generated events. This enables the tenant to identify the actual end-user more precisely when processing the events.

📘 API reference

For more info about sub profiles, see Subprofile API.