Documentation Adobe Pass Adobe Pass Authentication

Initiate Authentication initiate-authentication

Last update: Wed Mar 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.

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

Initiates the authentication process by informing of an MVPD selection event. Creates a record on the Adobe Pass Authentication database, which is reconciled when a successful response is received from the MVPD.

Endpoint

Called
By

Input
Params

HTTP
Method

Response

HTTP
Response

<SP_FQDN>/api/v1/authenticate

AuthN Module

1. requestor_id (Mandatory)
2. mso_id (Mandatory)
3. reg_code (Mandatory)
4. domain_name (Mandatory)
5. noflash=true -
(Mandatory, Residual parameter)
6. no_iframe=true (Mandatory, Residual parameter)
7. extra parameters (Optional)
8. redirect_url (Mandatory)

GET

The Login Web App is redirected to the MVPD login page.

302 for full redirect implementations

Input Parameter

Description

requestor_id

The Programmer requestor for which this operation is valid.

mso_id

The MVPD ID for which this operation is valid.

reg_code

The registration code generated by the Reggie service.

domain_name

The originating domain.

redirect_url

The Login Webapp redirect url after authentication completion.

IMPORTANT

Important: Mandatory parameters - Regardless of the client-side implementation, all the parameters above are mandatory.

Example:

code language-none
`domain_name=loginwebapp.com mso_id=sampleMvpdId reg_code=RO0885W requestor_id=sampleRequestorId noflash=true redirect_url=http://loginwebapp.com`

IMPORTANT

Important: Optional parameters

The call may also contain optional parameters that enable other functionalities like:

generic_data - enables the use of Promotional TempPass

code language-json
`Example: generic_data=("email":"email@domain.com")`

Notes notes

The value of the domain_name parameter must be set to one of the domain names registered with Adobe Pass Authentication. For more details, refer to Registration and Initialization.
Avoid using '&'reg_code in /authenticate request (Tech Note)
The redirect_url parameter must be the last one in order
The value of the redirect_url parameter must be URL-Encoded

recommendation-more-help

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