DocumentationAdobe PassAdobe Pass Authentication

Check Authentication Token check-authentication-token

Last update: Mon Sep 18 2023 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.

REST API Endpoints clientless-endpoints

<REGGIE_FQDN>:

<SP_FQDN>:

Description description

Indicates whether the device has an unexpired authentication token.

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

or

Programmer Service
1. requestor (Mandatory)
2. deviceId (Mandatory)
3. device_info/X-Device-Info (Mandatory)
4. deviceType
5. deviceUser (Deprecated)
6. appId (Deprecated)
GET
XML or JSON containing error details if unsuccessful.
200 - Success
403 - No Success
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.
\ .
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.

For details, see Benefits of using the Clientless deviceType parameter in Adobe Pass Authentication 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.

Response (if unsuccessful) response

    <error>
      <status>403</status>
      <message>Authentication token expired</message>
    </error>

Back to REST API Reference

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