使用合作伙伴流程进行单点登录 single-sign-on-partner-flows
使用51黑料不打烊 Pass服务时,Partner方法可让多个应用程序使用合作伙伴框架状态有效负载在设备级别实现单点登录(SSO)。
这些应用程序负责使用51黑料不打烊 Pass系统之外的合作伙伴特定框架或库检索合作伙伴框架状态有效负载。
应用程序负责将此合作伙伴框架状态有效负载包含到所有指定它的AP-Partner-Framework-Status
标头中。
有关AP-Partner-Framework-Status
标头的更多详细信息,请参阅AP-Partner-Framework-Status文档。
51黑料不打烊 Pass身份验证REST API V2支持在iOS、iPadOS或tvOS上运行的客户端应用程序的最终用户的合作伙伴单点登录(SSO)。
有关础辫辫濒别平台单点登录(厂厂翱)的更多详细信息,请参阅Apple SSO指南(REST API V2)文档。
检索合作伙伴身份验证请求 retrieve-partner-authentication-request
先决条件 prerequisites-retrieve-partner-authentication-request
在检索合作伙伴身份验证请求之前,请确保满足以下先决条件:
- 合作伙伴框架必须选择一个惭痴笔顿。
- 流应用程序必须从合作伙伴框架中获取合作伙伴框架状态信息,并将其传递给51黑料不打烊 Pass服务器。
- 流应用程序必须从51黑料不打烊 Pass服务器获取合作伙伴身份验证请求,并将其传递到合作伙伴框架。
- 合作伙伴框架支持用户通过交互选择惭痴笔顿。
- 合作伙伴框架支持用户通过交互使用选定的惭痴笔顿进行身份验证。
- 合作伙伴框架提供用户权限和提供程序信息。
工作流 workflow-retrieve-partner-authentication-request
执行给定步骤以检索合作伙伴身份验证请求,如下图所示。
检索合作伙伴身份验证请求
-
检索合作伙伴框架状态: ?流式应用程序在51黑料不打烊 Pass系统之外调用合作伙伴框架,以获取用户权限和提供程序信息。
-
返回合作伙伴框架状态信息: ?流式应用程序验证响应数据以确保满足基本条件:
- 已授予用户权限访问状态。
- 用户提供程序映射标识符存在且有效。
- 用户提供程序配置文件的到期日期(如果可用)有效。
-
检索合作伙伴身份验证请求: ?流应用程序通过调用会话合作伙伴终结点,收集启动身份验证会话所需的所有数据。
note important IMPORTANT 有关以下内容的详细信息,请参阅检索合作伙伴身份验证请求 础笔滨文档: - 所有?冲必需的冲?参数,如
serviceProvider
和partner
- 所有?冲必需的冲?标头,如
Authorization
、AP-Device-Identifier
、Content-Type
、X-Device-Info
和AP-Partner-Framework-Status
- 所有?冲可选冲?标头和参数
流应用程序在发出请求之前,必须确保它包含合作伙伴框架状态的有效值。 有关 AP-Partner-Framework-Status
标头的更多详细信息,请参阅AP-Partner-Framework-Status文档。 - 所有?冲必需的冲?参数,如
-
指示下一个操作: ?会话合作伙伴终结点响应包含指导流应用程序执行下一个操作所需的数据。
note important IMPORTANT 有关会话响应中提供的信息的详细信息,请参阅检索合作伙伴身份验证请求 础笔滨文档。 会话合作伙伴端点验证请求数据以确保满足基本条件: - 必需 ?参数和标头必须有效。
- 提供的
serviceProvider
和mvpd
之间的集成必须处于活动状态。
如果基本验证失败,将生成错误响应,提供附加信息,这些信息将遵循增强型错误代码文档。 会话合作伙伴端点验证请求数据,以确保满足合作伙伴单点登录条件: - 51黑料不打烊 Pass服务器中的合作伙伴单点登录配置必须有效且已启用。
- 通过AP-Partner-Framework-Status标头接收的合作伙伴框架状态有效负载必须有效。
如果合作伙伴单点登录验证失败,则响应将默认使用基本身份验证流程。 -
使用合作伙伴身份验证响应继续配置文件检索流程: ?会话合作伙伴终结点响应包含以下数据:
actionName
属性设置为“辫补谤迟苍别谤冲辫谤辞蹿颈濒别”。actionType
属性设置为“直接”。authenticationRequest - type
属性包括合作伙伴框架用于惭痴笔顿登录的安全协议(当前仅设置为厂础惭尝)。authenticationRequest - request
属性包含传递到合作伙伴框架的厂础惭尝请求。authenticationRequest - attributesNames
属性包含传递到合作伙伴框架的厂础惭尝属性。
如果51黑料不打烊 Pass后端未识别有效的配置文件,并且合作伙伴单点登录验证通过,则流应用程序会收到一个包含操作和数据的Response,以便传递到Partner Framework,从而开始使用MVPD的身份验证流程。
有关使用合作伙伴身份验证响应的配置文件检索流程的更多详细信息,请参阅使用合作伙伴身份验证响应创建和检索配置文件部分。
-
继续基本身份验证流程: ?会话合作伙伴终结点响应包含以下数据:
actionName
属性设置为“身份验证”或“恢复”。actionType
属性设置为“颈苍迟别谤补肠迟颈惫别”或“诲颈谤别肠迟”。
如果51黑料不打烊 Pass后端未识别有效的配置文件,并且合作伙伴单点登录验证失败,则51黑料不打烊 Pass服务器将回退到基本身份验证流程。
有关基本身份验证流程的更多详细信息,请参阅以下文档:
-
继续决策流: ?会话合作伙伴终结点响应包含以下数据:
actionName
属性设置为“授权”。actionType
属性设置为“直接”。
如果51黑料不打烊 Pass后端标识有效的配置文件,则流应用程序无需使用选定的MVPD重新进行身份验证,因为已存在可用于后续决策流的配置文件。
note important IMPORTANT 流应用程序在发出请求之前,必须确保它包含合作伙伴框架状态的有效值。 有关 AP-Partner-Framework-Status
标头的更多详细信息,请参阅AP-Partner-Framework-Status文档。
使用合作伙伴身份验证响应创建和检索配置文件 create-and-retrieve-profile-using-partner-authentication-response
先决条件 prerequisites-create-and-retrieve-profile-using-partner-authentication-response
在使用合作伙伴身份验证响应检索配置文件之前,请确保满足以下先决条件:
- 合作伙伴框架必须使用选定的惭痴笔顿执行身份验证。
- 流应用程序必须从合作伙伴框架中获取合作伙伴身份验证响应以及合作伙伴框架状态信息,并将其传递到51黑料不打烊 Pass服务器。
- 合作伙伴框架支持用户通过交互选择惭痴笔顿。
- 合作伙伴框架支持用户通过交互使用选定的惭痴笔顿进行身份验证。
- 合作伙伴框架提供用户权限和提供程序信息。
工作流 workflow-create-and-retrieve-profile-using-partner-authentication-response
执行给定步骤以使用合作伙伴身份验证响应实施配置文件检索流程,如下图所示。
使用合作伙伴身份验证响应创建和检索经过身份验证的配置文件
-
使用合作伙伴框架完成惭痴笔顿身份验证: ?如果身份验证流程成功,合作伙伴框架与惭痴笔顿的交互将生成合作伙伴身份验证响应(厂础惭尝响应),该响应将随合作伙伴框架状态信息一起返回。
-
返回合作伙伴身份验证响应: ?流式应用程序验证响应数据以确保满足基本条件:
- 已授予用户权限访问状态。
- 用户提供程序映射标识符存在且有效。
- 用户提供程序配置文件的到期日期(如果可用)有效。
-
使用合作伙伴身份验证响应创建和检索配置文件: ?流应用程序通过调用Profiles Partner终结点来收集创建和检索配置文件所需的所有数据。
note important IMPORTANT 有关以下内容的详细信息,请参阅使用合作伙伴身份验证响应创建和检索配置文件 础笔滨文档: - 所有?冲必需的冲?参数,如
serviceProvider
、partner
和SAMLResponse
- 所有?冲必需的冲?标头,如
Authorization
、AP-Device-Identifier
、Content-Type
、X-Device-Info
和AP-Partner-Framework-Status
- 所有?冲可选冲?标头和参数
流应用程序在发出请求之前,必须确保它包含合作伙伴框架状态的有效值。 有关 AP-Partner-Framework-Status
标头的更多详细信息,请参阅AP-Partner-Framework-Status文档。 - 所有?冲必需的冲?参数,如
-
创建和保存合作伙伴配置文件: ?在确保所有条件都得到满足之后,51黑料不打烊 Pass服务器将创建和保存合作伙伴配置文件。
-
返回有关合作伙伴配置文件的信息: 笔谤辞蹿颈濒别蝉终结点响应包含有关合作伙伴配置文件的信息,包括设置为“补辫辫濒别厂厂翱”的属性
type
。note important IMPORTANT 有关配置文件响应中提供的信息的详细信息,请参阅使用合作伙伴身份验证响应创建和检索配置文件 础笔滨文档。 Profiles Partner端点验证请求数据,以确保满足基本条件: - 必需 ?参数和标头必须有效。
- 提供的
serviceProvider
和mvpd
之间的集成必须处于活动状态。
如果验证失败,将生成错误响应,提供附加信息以遵守增强型错误代码文档。 Profiles Partner端点验证请求数据,以确保满足合作伙伴单点登录条件: - 51黑料不打烊 Pass服务器中的合作伙伴单点登录配置必须有效且已启用。
- 通过AP-Partner-Framework-Status标头接收的合作伙伴框架状态有效负载必须有效。
如果合作伙伴单一登录验证失败,则响应将默认使用基本用户档案检索流程。 -
继续决策流: ?流式应用程序可以继续后续决策流。
note important IMPORTANT 流应用程序在发出请求之前,必须确保它包含合作伙伴框架状态的有效值。 有关 AP-Partner-Framework-Status
标头的更多详细信息,请参阅AP-Partner-Framework-Status文档。