(Legacy) Free Preview for Temp Pass and Promotional Temp Pass free-preview-for-temp-pass-and-promotional-temp-pass
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
Allows the creation of an authentication token for Temp Pass and Promotional Temp Pass without the need for a second screen.
Endpoint
Called
By
By
Input
Params
Params
HTTP
Method
Method
Response
HTTP
Response
Response
<SP_FQDN>/api/v1/authenticate/freepreview
Streaming App
or
Programmer Service
or
Programmer Service
1. requestor_id (Mandatory)
2. deviceId (Mandatory)
3. mso_id (Mandatory)
4. domain_name (Mandatory)
5. device_info/X-Device-Info (Mandatory)
6. deviceType
7. deviceUser (Deprecated)
8. appId (Deprecated)
9. generic_data (Optional)
2. deviceId (Mandatory)
3. mso_id (Mandatory)
4. domain_name (Mandatory)
5. device_info/X-Device-Info (Mandatory)
6. deviceType
7. deviceUser (Deprecated)
8. appId (Deprecated)
9. generic_data (Optional)
POST
The successful response will be a 204 No Content, indicating that the token was successfully created and is ready to use for the authz flows.
204 - No Content
400 - Bad request
400 - Bad request
Input Parameter
Description
requestor_id
The Programmer requestorId for which this operation is valid.
deviceId
The device id bytes.
mso_id
The MVPD Id for which this operation is valid.
domain_name
The domain name for which a token will be granted. This is being compared with the domains of the service provider when an authorization token is being granted.
device_info/
X-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.
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 (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.
See Benefits of using clientless device type parameters
Note: the device_info will replace this parameter.
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.
See Benefits of using clientless device type parameters
Note: the device_info will replace this parameter.
deviceUser
The device user identifier.
Note: If used, deviceUser should have the same values as in the Create Registration Code request.
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,
Note: the device_info replaces this parameter. If used,
appId should have the same values as in the Create Registration Code request.generic_data
Used to limit the scope of the token for Promotional Temp Pass.
Back to REST API Reference
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b