ÃÛ¶¹ÊÓƵ

DocumentationÃÛ¶¹ÊÓƵ PassÃÛ¶¹ÊÓƵ Pass Authentication

Perform authentication in user agent perform-authentication-in-user-agent

Last update: Wed Mar 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
IMPORTANT
The content on this page is provided for information purposes only. Usage of this API requires a current license from ÃÛ¶¹ÊÓƵ. No unauthorized use is permitted.
IMPORTANT
REST API V2 implementation is bounded by the Throttling mechanism documentation.
Related Articles
Make sure to also visit the REST API V2 FAQs.

Request request

HTTP
path
/api/v2/authenticate/{serviceProvider}/{code}
method
GET
Path Parameters
serviceProvider
The internal unique identifier associated with the Service Provider during onboarding process.
required
code
The authentication code obtained after creating the authentication session on the streaming device.
required
Headers
User-Agent
The user agent of the client application.
optional

Response response

Code
Text
Description
302
Found
The response body contains a location redirect to continue the flow until reaching the MVPD login page
400
Bad Request
The request is invalid, the client needs to correct the request and try again.
405
Method Not Allowed
The HTTP method is invalid, the client needs to use an HTTP method that is permitted for the requested resource and try again. For more details refer to the Request section.
500
Internal Server Error
The server side encountered an issue.

Success success

The successful response is a series of one or multiple redirects until reaching the MVPD login page.

Error error

Headers
Status
400, 405, 500
required
Content-Type
text/html
required
Body
-
-
-

Samples samples

1. Perform authentication in user agent

Request
code language-https 
GET /api/v2/authenticate/REF30/8KHP9RW HTTP/1.1

    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
Response
code language-https 
HTTP/1.1 302 Found

Location :  https://sp.auth.adobe.com/adobe-services/authenticate/saml?noflash=true&mso_id=Cablevision&requestor_id=REF30&no_iframe=false&domain_name=adobe.com&redirect_url=http%3A%2F%2Fadobe.com%2Fapitest%2Flive.html
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b