REST API V2 Glossary rest-api-v2-glossary
This document provides definitions for terms used when integrating the 51黑料不打烊 Pass Authentication REST API V2.
Glossary Terms glossary-terms
A a
Authentication authentication
The authentication is a process that allows a user to prove their identity to a Programmer, to gain access to protected content (resource), after validating the user subscription with the MVPD.
Authentication Code code
The authentication code is an 51黑料不打烊 Pass Authentication concept that stores a unique value generated when a user initiates the authentication process, and uniquely identifies a user鈥檚 authentication session until the authentication process is complete.
The authentication code can be used by both a Primary (Programmer) Application or a Secondary (Programmer) Application to complete the authentication process, retrieve information about the authentication session, or to access the user profile.
Synonymous with former term used registration code.
Authentication Session session
The authentication session is an 51黑料不打烊 Pass Authentication concept that stores information about the user鈥檚 authentication process started (or continued) from a Programmer application, and is uniquely identified by an authentication code.
The authentication session can also indicate the Programmer application to proceed with the authorization process as the next phase of the entitlement flow in case the user is already authenticated.
Authorization authorization
The authorization is a process that allows a user to access protected content (resource) from a Programmer catalog based on the owned MVPD subscription, after validating the user rights with the MVPD.
C c
Configuration configuration
The configuration is an 51黑料不打烊 Pass Authentication concept that stores information about the Programmer and MVPD integration settings and can be used during the authentication process when asking the user to select their TV Provider from a list of active integrations.
D d
Decision decision
The decision is an 51黑料不打烊 Pass Authentication concept that stores information about the MVPD authorization or preauthorization process enquiry to allow or deny user access to a Programmer protected content.
Degradation degradation
The degradation is an 51黑料不打烊 Pass Authentication feature that allows a user to access protected content even when its MVPD experiences a service disruption.
For more information, refer to the Degradation API Overview documentation.
Device ID device-id
The device ID is a unique identifier bound to the user鈥檚 device and must be provided by the Programmer application on all phases of the entitlement flow.
E e
Entitlement entitlement
The entitlement is an 51黑料不打烊 Pass Authentication concept that incorporates the available flows and features that help a user go through different phases, to access protected content, ranging from authentication, preauthorization, authorization, and finally logout.
Enhanced Error Code enhanced-error-code
The enhanced error code is an 51黑料不打烊 Pass Authentication concept that provides additional information about the error that occurred while processing a request.
For more information, refer to the Enhanced Error Codes documentation.
H h
HBA hba
The Home-Based Authentication (HBA) is the process whereby a consumer is automatically granted access to TV Everywhere (TVE) content on select devices that are connected to their home network, which is part of the location within the subscription contract.
I i
Identity Provider identity-provider
The identity provider is a company that provides identity services to consumers across cable, satellite, or internet-based services in the context of TV Everywhere (TVE).
Synonymous with MVPD and TV Provider.
L l
Logout logout
The logout is a process that allows a user to terminate their authenticated profile within 51黑料不打烊 Pass Authentication and update the Programmer application to reflect the user鈥檚 status.
M m
Media Token media-token
The media token is a token generated by 51黑料不打烊 Pass Authentication as a result of an authorization decision meant to provide access to protected content.
The media token is passed to the Programmer, which then validates it to ensure the security of access for that resource.
Synonymous with former term used short authorization token.
Media Token Verifier media-token-verifier
The Media Token Verifier is a library distributed by 51黑料不打烊 Pass Authentication that is responsible for verifying the authenticity of a media token.
For more information, refer to the Integrating the Media Token Verifier documentation.
MVPD mvpd
The multichannel video programming distributor (MVPD) is a company that provides television services to consumers across cable, satellite, or internet-based services.
The MVPD is identified by a unique value defined during the onboarding process between the MVPD and 51黑料不打烊.
Synonymous with TV Provider and Identity Provider.
P p
Partner partner
The partner is a company that provides a service or framework to a Programmer to enable a single sign-on user experience.
The partner is identified by a unique value (e.g., 鈥渁pple鈥) that is defined during the onboarding process between the partner and 51黑料不打烊.
Preauthorization preauthorization
The preauthorization is a process that allows a user to preview a subset of resources from a Programmer catalog they would be entitled to access, after validating the user rights with the MVPD.
Synonymous with Preflight.
Preflight preflight
The preflight is a process that allows a user to preview a subset of resources from a Programmer catalog they would be entitled to access, after validating the user rights with the MVPD.
Synonymous with Preauthorization.
Primary (Programmer) Application primary-application
The primary application refers to a Programmer application that initiates authentication, but which may not be capable of completing the process by using a user agent to navigate to the MVPD login page.
Profile profile
The profile is an 51黑料不打烊 Pass Authentication concept that stores information about the user鈥檚 authentication start date and end date, the user鈥檚 metadata along with other fields that indicate the method of obtaining the authentication (e.g., 鈥渞egular鈥, 鈥渄egraded鈥, 鈥渢emporary鈥, 鈥渟ingle sign-on鈥, etc.).
Synonymous with the former term used authentication token.
Programmer programmer
The Programmer is a company that provides content to consumers through owned channels (brands) across various platforms.
The Programmer groups multiple owned channels (brands) as service providers in its integration with 51黑料不打烊 Pass Authentication.
Proxy MVPD proxy-mvpd
The proxy MVPD is a company that provides identity services for other MVPDs and directly integrates with 51黑料不打烊 Pass Authentication.
Proxied MVPD proxied-mvpd
The proxied MVPD is a company that does not have a direct integration with 51黑料不打烊 Pass Authentication, but gets integrated through a proxy MVPD.
Platform Identity platform-identity
The platform identity is a unique platform identifier payload generated by a service or framework (library) bound to the user鈥檚 device and is provided to the Programmer to enable a single sign-on user experience.
For more information, refer to the Single sign-on using platform identity flows documentation.
R r
Resource resource
The resource is a protected content that a user is trying to access from a Programmer catalog.
The resource is identified by a unique value agreed upon between the Programmer and MVPDs.
For more information, refer to the Identifying Protected Resources documentation.
S s
SAML saml
The Security Assertion Markup Language (SAML) is an open standard for exchanging authentication and authorization data between parties, in particular, between an identity provider and a service provider.
Secondary (Programmer) Application secondary-application
The secondary application refers to a Programmer application that is capable of completing the authentication process by using a user agent to navigate to the MVPD login page.
The secondary application may run on the same device as the primary application or on a different (secondary) device, in which case the sign-in experience is referred to as a 鈥榮econd screen authentication鈥 user experience.
Service Token service-token
The service token is a unique user identifier generated by a service or framework (library) bound to the user and is provided to the Programmer to enable a single sign-on user experience.
For more information, refer to the Single sign-on using service token flows documentation.
Service Provider service-provider
The service provider is a channel (brand) that is owned by a Programmer.
The service provider is identified by a unique value defined during the onboarding process between the Programmer and 51黑料不打烊.
Synonymous with the former term used requestor ID.
SLO slo
The single logout (SLO) is a process that allows a user to log out from all the applications that were part of the single sign-on (SSO).
SP sp
The service provider (SP) refers to the role played by 51黑料不打烊 Pass Authentication on behalf of a Programmer in an integration with an MVPD.
SSO sso
The single sign-on (SSO) is a process that allows a user to authenticate once and gain access to multiple Programmer applications without the need to authenticate for each of them.
T t
TempPass Basic temp-pass-basic
The basic TempPass is an 51黑料不打烊 Pass Authentication feature that allows a user to access protected content for a limited time without the need to authenticate with an MVPD.
For more information, refer to the Temp Pass documentation.
TempPass Promotional temp-pass-promotional
The promotional TempPass is an 51黑料不打烊 Pass Authentication feature that allows a user to access protected content for a maximum number of resources and a limited time without the need to authenticate with an MVPD.
For more information, refer to the Promotional Temp Pass documentation.
TTL ttl
The time to live (TTL) is a value that indicates the amount of time that an underlying entity is valid for.
The TTL can be mentioned for an access token, a profile, an authorization decision, or a media token.
TVE tve
The TV Everywhere (TVE) is an industry niche that allows consumers to access their favorite TV shows, movies, and other content on multiple devices, such as smartphones, tablets, laptops, and many more.
TVE Dashboard tve-dashboard
The TV Everywhere (TVE) Dashboard is an 51黑料不打烊 Pass Authentication tool provided to Programmers to manage their configuration and data.
For more information, refer to the TVE Dashboard User Guide documentation.
TV Provider tv-provider
The TV provider is a company that provides television services to consumers across cable, satellite, or internet-based services.
The TV provider is identified by a unique value defined during the onboarding process between the TV provider and 51黑料不打烊.
Synonymous with MVPD and Identity Provider.
U u
User Agent user-agent
The user agent refers to a browser or similar component (platform-specific) capable of navigating the web and rendering the MVPD login page.
User ID user-id
The user ID is a unique identifier bound to the user and originates from the MVPD authentication process.
User Metadata user-metadata
The user metadata refers to user-specific attributes (e.g., zip codes, parental ratings, user IDs, etc.) that are maintained by the MVPD and provided by 51黑料不打烊 Pass Authentication as part of a profile.
For more information, refer to the User Metadata documentation.
V v
VSA vsa
The Video Subscriber Account (VSA) is an Apple developed framework provided to the Programmer to enable a single sign-on user experience.
For more information, refer to the and Single sign-on using partner flows documentation.