Retrieve partner authentication request

Last update: May 20, 2025
IMPORTANT
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
REST API V2 implementation is bounded by the Throttling mechanism documentation.

Request

HTTP
path
/api/v2/{serviceProvider}/sessions/sso/{partner}
method
POST
Path Parameters
serviceProvider
The internal unique identifier associated with the Service Provider during onboarding process.
required
partner
The name of the partner (e.g., Apple) that provides the single sign-on framework integrated with Adobe Pass Authentication flows.
required
Body Parameters
domainName
The originating domain of the application performing MVPD login.

If the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.

This will be used in case of fallback scenarios where the response indicates that the streaming application should proceed with the basic authentication flow.
required
redirectUrl
The final redirect URL to which the user agent navigates when the authentication flow for the MVPD is completed.

The value must be URL-encoded.

If the streaming device platform has limitations in providing a value, then an application will have to resume the authentication session and provide a valid value.

This will be used in case of fallback scenarios where the response indicates that the streaming application should proceed with the basic authentication flow.
required
Headers
Authorization
The generation of the bearer token payload is described in the Authorization header documentation.
required
Content-Type
The accepted media type for the resources being sent.

It must be application/x-www-form-urlencoded.
required
AP-Device-Identifier
The generation of the device identifier payload is described in the AP-Device-Identifier header documentation.
required
X-Device-Info
The generation of the device information payload is described in the X-Device-Info header documentation.

It is strongly recommended to always use it when the application's device platform allows for the explicit provision of valid values.

When provided, the Adobe Pass Authentication backend will merge explicitly set values with extracted values implicitly (by default).

When not provided, the Adobe Pass Authentication backend will use extracted values implicitly (by default).
required
AP-Partner-Framework-Status
The generation of the single sign-on payload for the Partner method is described in the AP-Partner-Framework-Status header documentation.

For more details about single sign-on enabled flows using a partner, refer to the Single sign-on using partner flows documentation.
optional
X-Forwarded-For
The IP address of the streaming device.

It is strongly recommended to always use it for server to server implementations, particularly when the call is made by the programmer service rather than the streaming device.

For client to server implementations, the IP address of the streaming device is sent implicitly.
optional
Accept
The media type accepted by the client application.

If specified, it must be application/json.
optional
User-Agent
The user agent of the client application.
optional