Documentation Adobe Pass Adobe Pass Authentication

(Legacy) Return Registration Record return-registration-record

Last update: Fri Dec 13 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Authentication

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.

IMPORTANT

Make sure you stay informed about the latest Adobe Pass Authentication product announcements and decommissioning timelines aggregated in the Product Announcements page.

NOTE

REST API implementation is bounded by Throttling mechanism

REST API Endpoints clientless-endpoints

<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 description

Returns registration code record containing registration code UUID, registration code, and hashed device ID.

Endpoint

Called
By

Input
Params

HTTP
Method

Response

HTTP
Response

<REGGIE_FQDN>;/reggie/v1/{requestorId}/regcode/{registrationCode}

For example:

<REGGIE_FQDN>/reggie/v1/sampleRequestorId/regcode/TJJCFK?format=xml

Streaming App

or

Programmer Service

1. requestor
(Path component)
2. registration code
(Path component)

GET

XML or JSON containing a registration code and information. See schema and sample below.

200

Input Parameter

Description

requestor

The Programmer requestorId for which this operation is valid.

registration code

The registration code value that would be displayed on the Streaming Device (to be entered into the authentication flow).

Response XML Schema response-xml-schema

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

Sample Response sample-response

    <?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>

recommendation-more-help

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