You need to enable JavaScript to run this app.
导航

OAuth 2.0

最近更新时间2023.10.10 17:20:35

首次发布时间2022.10.11 14:08:04

自有账号系统支持通过 OAuth 2.0 通用授权协议实现单点登录。将观看限制设置为 OAuth 2.0 后,用户必须在您的自有账号系统完成登录,才能进入直播间观看直播或发送评论等。

前提条件

  • 您已开通旗舰版或定制版套餐。具体操作,详见服务购买
  • 确保您拥有火山引擎主账号或具备观看页管理 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理
  • 联系企业直播技术支持获取重定向地址。
  • 在您的自有账号系统完成企业直播的备案。备案时需填写重定向地址,备案后可生成企业直播的身份识别码客户端 ID(Client ID)和客户端密钥(Client Secret)。

背景信息

OAuth 2.0 是一个开放、标准的授权协议,允许第三方应用通过令牌访问用户资源,而无需获取用户名与密码。本文中第三方应用指企业直播。
OAuth 2.0 定义了以下四种获取令牌的授权方式:授权码、隐藏式、密码式、客户端凭证。企业直播使用的是授权码模式,即先申请一个授权码,再用该授权码换取访问令牌,安全性是所有授权方式中最高的。详见流程详解

流程详解

企业直播可以通过授权码模式获取到您自有账号系统中的用户数据。详细流程如下:
图片

  1. 用户通过链接或二维码访问企业直播观看页面。
  2. 企业直播向资源所有者请求授权码,并向其提供客户端 ID 和作用域 Scope。页面跳转至您的自有账号系统登录页面。
  3. 用户完成登录操作后,资源所有者返回授权码至企业直播。页面跳转至企业直播技术支持提供的重定向地址。
  4. 企业直播通过客户端 ID 和客户端密钥表明身份,并提供授权码向您的授权服务器请求访问令牌。
  5. 授权服务器对企业直播进行身份验证并验证授权码。验证通过后,向企业直播颁发访问令牌。
  6. 企业直播向您的资源服务器请求受保护的用户数据并提供访问令牌进行身份验证。
  7. 资源服务器通过访问令牌的验证后,向企业直播提供用户数据。

说明

  • 如果您使用的是非标准的 OAuth 2.0 登录模式,授权服务器在向企业直播颁发访问令牌的同时(步骤 5)会返回受保护的用户数据至企业直播。
  • 如果用户的浏览器存储了您自有账号系统的登录状态,则资源所有者会在企业直播请求授权码后直接返回授权码,无需用户完成登录操作。

操作步骤

  1. 登录企业直播控制台

  2. 直播列表中,单击进入直播间。

  3. 在左侧导航栏,选择观看页管理 > 观看限制

  4. 观看账号下,选择 OAuth2.0 作为观看账号并完成以下配置。
    图片

    参数

    描述

    登录平台名称

    您的自有账号系统平台名称。建议用英文填写。

    重定向地址

    接收授权码的回调地址。与在您的自有账号系统备案企业直播时填写的授权回调地址一致。

    获取授权码地址

    获取授权码的地址。

    获取token地址

    获取访问令牌的地址。

    获取用户信息

    选择 URL标识字段

    • URL:填写获取用户信息的地址。
    • 标识字段:填写用于解析用户信息的标识字段。如果您使用的是非标准的 OAuth 2.0 登录模式,选择该选项。在授权服务器向企业直播颁发访问令牌的同时,企业直播即可获取到受保护的用户数据。

    用户名对应字段

    您自有账号系统中用户名对应的字段,用于解析用户名。

    说明

    为避免个人信息泄露,请勿使用手机号、身份证号等信息作为用户在您自有账号系统的用户名。

    用户ID对应字段

    您自有账号系统中用户 ID 对应的字段,用于解析用户 ID。

    说明

    为避免个人信息泄露,请勿使用手机号、身份证号等信息作为用户在您自有账号系统的用户 ID。

    Client id

    表明企业直播身份的客户端 ID。在您的自有账号系统完成企业直播的备案后即可生成。

    Client secret

    表明企业直播身份的客户端密钥。在您的自有账号系统完成企业直播的备案后即可生成。

    作用域Scope

    授权范围。企业直播只能访问授权范围内的资源。
    如果您的自有账号系统中 Scope没有默认值,则该选项必填。

    试看

    打开开关并选择试看时间。在试看时间内,观众可以在不登录直播间的情况下观看直播或回放。详见试看

    说明

    您也可以将次要观看账号设置为 OAuth2.0。关于主次观看限制的配置,详见主次观看限制