使用 OAuth 进行身份验证
通过配置 OAuth 凭据,您可以向 OAuth 服务提供商验证您的自定义云数据源 (CCDS)。如果数据设计者想要使用 CCDS,则必须登录并对访问请求进行身份验证。
如果您创建了 Workday 凭据,则可以使用此凭据对您的 CCDS 进行身份验证。
先决条件
先决条件
- 不熟悉 CCDS?请参见 概念:自定义 云数据源 (CCDS) 和设置自定义云数据源 (CCDS)。
- 设置 CCDS 并使用 OAuth 对其进行身份验证所需的权限:中的“管理”>“权限集”“集成开发者”权限
- 为 CCDS 请求授权所需的权限:中的“管理”>“权限集”“数据设计者”
导航
从导航菜单中,转至 “集成”
“设计集成”
设置和配置 OAuth
使用“组件库”中的“凭据”窗格可创建和管理 OAuth 配置。
- 在“凭据”窗格中,选择“新建凭据”。
- 选择“OAuth 1.0a”或“OAuth 2.0”,为凭据命名,然后单击“创建”。OAuth 1.0a 凭据和 OAuth 2.0 凭据使用不同的图标,以便识别。
- 填写以下设置:OAuth 1.0a设置包含以下字段:
- 用户密钥:在注册过程中发放给客户端的客户端编号或客户端识别号。用户密钥和用户密码构成凭据对,用于对提出请求的客户端进行标识和身份验证。
- 用户密码:客户端的密钥。
- 支持的签名方法:预定义的签名方法为“HMAC-SHA1”,无法更改。
- 请求令牌服务 HTTP 方法:从下拉列表中选择“GET”或“POST”。
- 请求令牌服务端点:客户端使用该端点请求一组令牌凭据。
- 授权重定向 URL:此 URL 用于获取临时凭据,以对委派请求进行标识。
- 访问令牌服务 HTTP 方法:根据外部访问令牌服务需求,选择“GET”或“POST”。
- 访问令牌服务端点:该 URL 用于获取令牌,以便访问受保护资源。
- 向请求 URL 添加 OAuth 参数:该 URL 用于在 URI 的方案和命名机构范围内标识资源。
OAuth 2.0设置具有以下附加字段:- 用户密钥:在注册过程中发放给客户端的客户端编号或客户端识别号。用户密钥和用户密码构成凭据对,用于对提出请求的客户端进行标识和身份验证。
- 用户密码:客户端的密钥。
- 重定向 URI:在授权后重定向用户。集成开发者在第三方服务器上设置 OAuth 2.0 应用程序期间使用此 URI。此字段无法更改。
- 范围:授权访问请求的服务或对象的范围。
- 需要授权标头:如果第三方服务提供商在授权后请求或刷新访问令牌时,要求在请求中提供授权标头,请选中此复选框。
- 访问令牌可续订:如果初始授权流程可获取原始访问令牌和刷新令牌以进行续订,以及第三方服务器上的访问令牌会自动续订,请选中此复选框。
- 授权重定向 URL:此 URL 用于获取临时凭据,以便对委派请求进行标识。
- 访问令牌服务 HTTP 方法:根据外部访问令牌服务需求,选择“GET”或“POST”。
- 访问令牌服务端点:该 URL 用于获取令牌,以便访问受保护资源。
- 令牌到期默认时间(秒):没有到期时间的访问令牌所对应的默认到期时间(秒)。
- 在“操作”窗格中,单击“保存”。
如需进一步了解相关信息,请参见 OAuth 1.0 协议和 OAuth 2.0 授权框架。
使用 OAuth 对 CCDS 进行身份验证
以下步骤适用于集成开发者。
- 在“数据源”窗格中选择您的 CCDS。
- 在“数据设置”选项卡中,选择“需要凭据”。
- 从“凭据”下拉列表中,选择您的 OAuth 凭据。
- 在“脚本”选项卡中更新您的脚本,以纳入您的 OAuth 凭据。例如,response=ai.authorizedRequest(url,method,body,headers)。
- 在“操作”窗格中,单击“保存”。
请求授权
以下步骤适用于数据设计者。
- 在“数据源”窗格中选择您的 CCDS。
- 在“操作”窗格中,选择“请求授权”,以便生成 CCDS 授权请求。系统会打开一个新的浏览器窗口,用于为第三方网站授权。授权完成后,OAuth 1.0a 应用程序会连接到您的帐户,从而访问数据。对于 OAuth 2.0,如果第三方网站允许,则可能会在 OAuth 2.0 的“Settings”>“Scope” 字段中指明您提供的完整服务范围。
- 刷新Adaptive PlanningCCDS 数据源页面注意“操作”窗格中的全部菜单项是否均已启用。
“数据源设置”选项卡会显示“授权状态”以及第三方授权编号和授权日期。不同提供商的授权到期日期各不相同。请注意您的授权何时到期。
在“操作”窗格中单击“重置授权”,以根据需要重新授权。您可以使用“重置授权”,向第三方网站提供不同的授权凭据。