DocumentationAdobe PassAdobe Pass Authentication

Retrieve Authorization Token retrieve-authorization-token

Last update: Thu Jul 18 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

Retrieves authorization (AuthZ) Token.

Endpoint
Called
By
Input
Params
HTTP
Method
Response
HTTP
Response
<SP_FQDN>/api/v1/tokens/authz

For example:

<SP_FQDN>/api/v1/tokens/authz
Streaming App

or

Programmer Service
1. requestor (Mandatory)
2. deviceId (Mandatory)
3. resource (Mandatory)
4. device_info/X-Device-Info (Mandatory)
5. deviceType
6. deviceUser (Deprecated)
7. appId (Deprecated)
GET
1. Success
2. Authentication Token
not found or expired:
XML explaining reason
for authn token not found
3. Authorization token
not found:
XML explanation
4. Authorization token
expired:
XML explanation
200 - Success
412 - No AuthN

404 - No AuthZ

410 - AuthZ Expired
Input Parameter
Description
requestor
The Programmer requestorId for which this operation is valid.
deviceId
The device id bytes.
resource
A string that contains a resourceId (or MRSS fragment), identifies the content requested by a user and is recognized by MVPD authorization endpoints.
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.
deviceType
The device type (for example, 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.

Sample Response response

Success

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <authorization>
        <expires>1348148289000</expires>
        <mvpd>sampleMvpdId</mvpd>
        <requestor>sampleRequestorId</requestor>
        <resource>sampleResourceId</resource>
        <proxyMvpd>sampleProxyMvpdId</proxyMvpd>
    </authorization>

JSON:

    {
        "mvpd": "sampleMvpdId",
        "resource": "sampleResourceId",
        "requestor": "sampleRequestorId",
        "expires": "1348148289000",
        "proxyMvpd": "sampleProxyMvpdId"
    }

Authentication Token not found or expired:

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <error>
        <status>412</status>
        <message>User not authenticated</message>
    </error>

JSON:

    {
        "status": 412,
        "message": "User not authenticated",
        "details": null
    }

Authorization Token not found:

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <error>
        <status>404</status>
        <message>Not found</message>
    </error>

JSON:

    {
        "status": 404,
        "message": "Not Found",
        "details": null
    }

Authorization Token expired:

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <error>
        <status>410</status>
        <message>Gone</message>
    </error>

JSON:

    {
        "status": 410,
        "message": "Gone",
        "details": null
    }
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b