Documentation Adobe Pass Adobe Pass Authentication

Registration Page registration-page

Last update: Wed Mar 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Authentication

REST API Endpoints clientless-endpoints

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

<REGGIE_FQDN>:

Production - api.auth.adobe.com
Staging - api.auth-staging.adobe.com

<SP_FQDN>:

Production - api.auth.adobe.com
Staging - api.auth-staging.adobe.com

Description create-reg-code-svc

Returns randomly generated registration Code and Login Page URI.

Endpoint

Called
By

Input
Parameter

HTTP
Method

Response

HTTP
Response

<REGGIE_FQDN>/reggie/v1/{requestor}/regcode
For example:
REGGIE_FQDN/reggie/v1/sampleRequestorId/regcode

Streaming App
or
Programmer Service

1. requestor
(Path component)
2. deviceId (Hashed)
(Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. mvpd (Optional)
5. ttl (Optional)
6. deviceType
7. deviceUser (Deprecated)
8. appId (Deprecated)

POST

XML or JSON containing a registration code and information or error details if unsuccessful. See schemas and samples below.

201

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 paramater, but due to the potential size of this paramater 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.

mvpd

The MVPD ID for which this operation is valid.

ttl

How long this regcode should live in seconds.
Note: The maximum value allowed for ttl is 36000 seconds (10 hours). Higher values result in a 400 HTTP response (bad request). If ttl is left empty, Adobe Pass Authentication sets a default value of 30 minutes.

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 example, Roku, AppleTV, and Xbox.
See, Benefits of using clientless device type parameter in pass metrics
Note: the device_info will replace this parameter.

deviceUser

The device user identifier.

appId

The application id/name.
Note: the device_info replaces this parameter.

CAUTION

Streaming Device IP Address

For Client-to-Server implementations, the Streaming Device IP Address is implicitly sent with this call. For Server-to-Server implementations, where the regcode call is made be the Programmer Service and not the Streaming Device, the following header is required to pass the Streaming Device IP Address:

code language-none
`X-Forwarded-For : <streaming_device_ip>`

where <streaming\_device\_ip> is the Streaming Device public IP address.

Example :

code language-none
`POST /reggie/v1/{req_id}/regcode HTTP/1.1</br>X-Forwarded-For:203.45.101.20`

Response XML Schema xml-schema

Registration Code XSD registration-code-xsd

    <?xml version="1.0" encoding="UTF-8"?>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="model.mvc.reggie.pass.adobe.com"
            targetNamespace="model.mvc.reggie.pass.adobe.com"
            attributeFormDefault="unqualified"
            elementFormDefault="unqualified">
        <xs:element name="regcode">
            <xs:complexType>
                <xs:all>
                    <xs:element name="id" type="xs:string" />
                    <xs:element name="code" type="xs:string" />
                    <xs:element name="requestor" type="xs:string" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="mvpd" type="xs:string" minOccurs="1" maxOccurs="1"/
                    <xs:element name="generated" type="xs:long" />
                    <xs:element name="expires" type="xs:long" />
                    <xs:element name="info" type="infoType" maxOccurs="1"/>
                </xs:all>
            </xs:complexType>
        </xs:element>
        <xs:complexType name="infoType">
            <xs:all>
                <xs:element name="deviceId" type="xs:base64Binary" minOccurs="1" maxOccurs="1"/>
                <xs:element name="deviceType" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="deviceUser" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="appId" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="appVersion" type="xs:string" minOccurs="0" maxOccurs="1"/>
                <xs:element name="registrationURL" type="xs:anyURI" minOccurs="0" maxOccurs="1"/>
            </xs:all>
        </xs:complexType>
    </xs:schema>

Element Name

Description

UUID generated by Registration Code Service

code

Registration Code generated by Registration Code Service

requestor

Requestor ID

mvpd

Mvpd ID

generated

Registration Code creation timestamp (in milliseconds since Jan 1 1970 GMT)

expires

Timestamp when the registration code expires ((in milliseconds since Jan 1 1970 GMT)

deviceId

Unique Device ID (or XSTS token)

deviceType

Device Type

deviceUser

User logged-in to the device

appId

Application Id

appVersion

Application Version

registrationURL

URL to the Login Web App to be displayed to the end user

Error Message XSD error-message

    <?xml version="1.0" encoding="UTF-8"?>
    <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="rest.pass.adobe.com"
               targetNamespace="rest.pass.adobe.com"
               attributeFormDefault="unqualified"
               elementFormDefault="unqualified">
        <xs:element name="error">
            <xs:complexType>
                <xs:all>
                    <xs:element name="status" type="xs:int" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="message" type="xs:string" minOccurs="1" maxOccurs="1"/>
                    <xs:element name="details" type="xs:string" minOccurs="0" maxOccurs="1"/>
                </xs:all>
            </xs:complexType>
        </xs:element>
    </xs:schema>

Sample Response sample-response

XML:


    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ns2:regcode xmlns:ns2="model.mvc.reggie.pass.adobe.com">
        <id>678f9fea-a1cafec8-1ff0-4a26-8564-f6cd020acf13</id>
        <code>TJJCFK</code>
        <requestor>sampleRequestorId</requestor>
        <mvpd>sampleMvpdId</mvpd>
        <generated>1348039846647</generated>
        <expires>1348043446647</expires>
        <info>
            <deviceId>dGhpc0lkQUR1bW15RGV2aWNlSWQ=</deviceId>
            <deviceType>xbox</deviceType>
            <deviceUser>JD</deviceUser>
            <appId>2345</appId>
            <appVersion>2.0</appVersion>
            <registrationURL>http://loginwebapp.com</registrationURL>
        </info>
    </ns2:regcode>

JSON:


    {
        "id": "678f9fea-9d364b29-246c-488f-b97e-298566d1b9e0",
        "code": "D4BDU2W",
        "requestor": "sampleRequestorId",
        "mvpd": "sampleMvpdId",
        "generated": 1348039555877,
        "expires": 1348043155877,
        "info": {
            "deviceId": "dGhpc0l.kQUR1bW15RGV2.aWNlSWQ=",
            "deviceType": "xboxOne",
            "deviceUser": "JD",
            "appId": "2345",
            "appVersion": "2.0",
            "registrationURL": "http://loginwebapp.com"
        }
    }

recommendation-more-help

3f5e655c-af63-48cc-9769-2b6803cc5f4b