DocumentationAdobe PassAdobe Pass Authentication

User Metadata user-metadata

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
NOTE
The content on this page is provided for information purposes only. Usage of this API requires a current license from Adobe. No unauthorized use is permitted.
NOTE
REST API implementation is bounded by Throttling mechanism

REST API Endpoints clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Description description

Retrieve metadata that MVPD shared about the authenticated user.

Endpoint
Called
By
Input
Params
HTTP
Method
Response
HTTP
Response
<SP_FQDN>/api/v1/tokens/usermetadata
Streaming App

or

Programmer Service
1. requestor
2. deviceId (Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. deviceType
5. deviceUser (Deprecated)
6. appId (Deprecated)
GET
XML or JSON containing user metadata or error details if unsuccessful.

200 - Success

404 - No metadata found

412 - Invalid AuthN Token (e.g., expired token)

Input Parameter
Description
requestor
The Programmer requestorId for which this operation is valid.
deviceId
The device id bytes.

device_info/

X-Device-Info

Streaming Device information.

Note: This MAY be passed device_info as a URL parameter, but due to the potential size of this parameter and limitations on the length of a GET URL, it SHOULD be passed as X-Device-Info n the http header.

See the full details in Passing Device and Connection Information.
deviceType
The device type (e.g. Roku, PC).

If this parameter is set correctly, ESM offers metrics that are broken down per device type when using Clientless, so that different types of analysis can be performed for e.g. Roku, AppleTV, Xbox etc.

See Benefits of using clientless device type parameter in Pass metrics

Note: The device_info replaces this parameter.
deviceUser
The device user identifier.

Note: If used, deviceUser should have the same values as in the Create Registration Code request.
appId
The application id/name.

Note: The device_info replaces this parameter. If used, appId should have the same values as in the Create Registration Code request.
NOTE
User metadata information should be available after the authentication flow has completed, but can be updated on the authorization flow, depending on the MVPD and on the metadata type.

Sample Response sample-response

After a successful call, the server will respond with a XML (default) or JSON object with a structure similar to the one presented below:

    {
        updated: 1334243471,
        encrypted: ["encryptedProp"],
        data: {
              zip: ["12345", "34567"],
              maxRating: {
                  "MPAA": "PG-13",
                  "VCHIP": "TV-Y",
                  "URL": "http://exam.pl/e/manage/ratings"
                         },
              householdID: "3456",
              userID: "BgSdasfsdk23/dsaf3+saASesadgfsShggssd=",
              channelID: ["channel-1", "channel-2"]
              }
    }

At the root of the object there will be three nodes:

  • updated: specifies an UNIX timestamp that represents the last time the metadata was updated. This property will be set initially by the server when generating the metadata during the authentication phase. Subsequent calls (after the metadata has been updated) will result in an incremented timestamp.
  • data: contains the actual metadata values.
  • encrypted: an array listing the encrypted properties. To decrypt a specific metadata value, the Programmer must perform a Base64 decode on the metadata then apply a RSA decryption on the resulting value, using it’s own private key (Adobe encrypts the metadata on the server using the Programmer’s public certificate).

In case of an error, the server will return a XML or JSON object that specifies a detailed error message.

For more information, see User Metadata.

Back to REST API Reference

recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b