DocumentationAdobe PassAdobe Pass Authentication

Retrieve Authentication Token retrieve-authentication-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 authentication (AuthN) Token.

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

For example:

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

or

Programmer Service
1. requestor (Mandatory)
2. deviceId (Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. deviceType (Deprected)
5. deviceUser (Deprecated)
6. appId (Deprecated)
GET
XML or JSON containing authentication information or error details if unsuccessful.
200 - Success.
404 - Token Not Found
410 - Token expired
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.
deviceType
The device type (for example, Roku, PC).

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.

Sample Response response

Success

XML:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <authentication>
         <expires>1601114932000</expires>
         <userId>sampleUserId</userId>
         <mvpd>sampleMvpdId</mvpd>
         <requestor>sampleRequestor</requestor>
    </authentication>

JSON:

    {
         "requestor": "sampleRequestor",
         "mvpd": "sampleMvpdId",
         "userId": "sampleUserId",
         "expires": "1601114932000"
    }

Authentication 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"
    }
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b