HTTP > 发出OAuth 2.0请求模块

NOTE
除Adobe Workfront许可证外,Adobe Workfront Fusion还需要Adobe Workfront Fusion许可证。

要向需要OAuth 2.0授权的服务器发出Adobe Workfront Fusion HTTP(S)请求,您首先需要创建OAuth连接。 Adobe Workfront Fusion确保通过此连接进行的所有调用都具有适当的授权标头,并在需要时自动刷新关联的令牌。

Workfront Fusion支持以下OAuth 2.0身份验证流程:

  • 授权代码流程
  • 隐式流

其他流(如资源所有者密码凭据流和客户端凭据流)不自动支持通过此模块运行。

有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架

NOTE
如果您要连接到的Adobe产品当前没有专用连接器,我们建议您使用Adobe Authenticator模块。
有关详细信息,请参阅Adobe Authenticator模块

访问要求

您必须具有以下权限才能使用本文中的功能:

Adobe Workfront 计划*
Pro或更高版本
Adobe Workfront 许可证*
计划,工作
Adobe Workfront Fusion 许可证**

当前许可证要求:无Workfront Fusion许可证要求。

旧版许可证要求:Workfront Fusion for Work Automation and Integration

产品

当前产品要求:如果您有Select或Prime Adobe Workfront计划,则贵组织必须购买Adobe Workfront Fusion和Adobe Workfront才能使用本文中描述的功能。 Workfront Fusion包含在Ultimate Workfront计划中。

旧版产品要求:您的组织必须购买Adobe Workfront Fusion和Adobe Workfront,才能使用本文中介绍的功能。

要了解您拥有什么计划、许可证类型或访问权限,请与Workfront管理员联系。

有关Adobe Workfront Fusion许可证的信息,请参阅Adobe Workfront Fusion 许可证

正在为OAuth请求创建连接

有关在HTTP > 发出OAuth 2.0请求模块中创建连接的一般说明

  1. 在target服务中创建要Adobe Workfront Fusion与之通信的OAuth客户端。 该选项最有可能在给定服务的开发人员部分找到。

    1. 创建客户端时,在Redirect URLCallback URL字段中输入相应的URL:

      table 0-row-2 1-row-2
      美洲/APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2
    2. 创建客户端后,给定服务显示2个密钥: Client IDClient Secret。 某些服务调用这些App KeyApp Secret 。 将密钥和秘密保存到安全位置,以便您可以在Workfront Fusion中创建连接时提供它们。

  2. 在给定服务的API文档中查找Authorize URIToken URI。 这些是Workfront Fusion与target服务通信的URL地址。 这些地址用于OAuth授权。

    note note
    NOTE
    如果服务使用隐式流,则您只需要Authorize URI
    note info
    INFO
    示例: Yahoo地址:
    • 授权URI:
    https://api.login.yahoo.com/oauth2/request_auth
    • 令牌URI:
    https://api.login.yahoo.com/oauth2/get_token
  3. (视情况而定)如果目标服务使用作用域(访问权限),请检查服务如何分隔各个作用域,并确保在高级设置中相应地设置分隔符。 如果未正确设置分隔符,Workfront Fusion将无法创建连接,并且您会收到无效的范围错误。

  4. 完成上述步骤后,即可开始在Workfront Fusion中创建OAuth连接。 将OAuth 2.0 HTTP(S)请求和响应处理模块添加到您的方案。

  5. 在模块的“连接”字段中,单击​ 添加

  6. 填写以下字段以创建连接:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 layout-auto html-authored no-header
    连接名称 输入连接的名称。
    流类型

    选择获取令牌的流程。

    • 授权代码:输入服务的API文档中的Authorize URIToken URI
    • Implicit:输入服务的API文档中的Authorize URI
    作用域 添加单个范围。 您可以在给定服务的开发人员(API)文档中找到此信息。
    范围分隔符

    选择上面输入的范围应该用分隔符。 您可以在给定服务的开发人员(API)文档中找到此信息。

    警告:如果未正确设置分隔符,Workfront Fusion将无法创建连接,并且您会收到无效的范围错误。

    客户端ID 输入客户端ID。 在要连接的服务中创建OAuth客户端时,您获得了客户端ID。
    客户端密钥 输入客户端密码。 在要连接的服务中创建OAuth客户端时,您获得了客户端密钥。
    Authorize parameters

    添加要包含在授权调用中的任何参数。 以下标准参数始终自动包含在内,无需添加。

    标准参数:

    • response_type

      [!UICONTROL授权代码流的code 和[!UICONTROL隐式流的token

    • redirect_uri

      table 0-row-2 1-row-2 layout-auto html-authored no-header
      美洲/APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2
    • client_id

      创建帐户时收到的客户端ID

    访问令牌参数

    添加要包含在令牌调用中的任何参数。 以下标准参数始终自动包含在内,无需添加。

    标准参数:

    • grant_typeauthorization_code

    • redirect_uri:

      table 0-row-2 1-row-2 layout-auto html-authored no-header
      美洲/APAC https://app.workfrontfusion.com/oauth/cb/oauth2
      EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2
    • client_id:创建帐户时收到的客户端ID会自动包含在请求正文中

    • client_secret:您在创建帐户时收到的客户端密钥会自动包含在请求正文中

    • 代码:授权请求返回的代码

    注意:

    OAuth 2.0标准在此步骤中支持至少2种客户端身份验证方法(client_secret_basicclient_secret_post)。 Workfront Fusion通过client_secret_post方法自动发送指定的客户端ID和密码。 因此,这些参数会自动包含在令牌请求正文中。

    有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架

    刷新令牌参数

    添加要包含在令牌调用中的任何参数。 以下标准参数始终自动包含在内,无需添加。

    标准参数:

    • grant_typerefresh_token

    • refresh_token:您连接到的服务所获得的最新刷新令牌

    • client_id:创建帐户时收到的客户端ID会自动包含在请求正文中

    • client_secret:创建帐户时收到的客户端密钥会自动包含在请求正文中

    注意:

    OAuth 2.0标准在此步骤中支持至少2种客户端身份验证方法(client_secret_basicclient_secret_post)。 Workfront Fusion通过client_secret_post方法自动发送指定的客户端ID和密码。 因此,这些参数会自动包含在令牌请求正文中。

    有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架

    Custom Headers

    指定要包含在Token和RRefresh Token步骤的标头中的任何其他键和值。

    注意:

    OAuth 2.0标准在此步骤中支持至少2种客户端身份验证方法(client_secret_basicclient_secret_post)。 Workfront Fusion不自动支持client_secret_basic方法。 如果您连接的服务要求将客户端ID和客户端密钥组合为一个字符串,然后将base64编码到授权标头,则您应在此处添加该标头和密钥值。

    有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架

    令牌放置

    选择在连接到指定的URL时是在标头、查询字符串中发送令牌,还是同时在这两种情况下发送令牌。

    令牌最常在请求标头中发送。

    标头令牌名称 在标头中输入授权令牌的名称。 默认值: Bearer
    查询字符串参数名称 在查询字符串中输入授权令牌的名称。 默认值: access_token
  7. 单击​ 继续 ​以保存连接设置。

  8. 继续OAuth 2.0请求模块设置

有关在HTTP >创建OAuth 2.0请求模块中创建与Google的连接的说明

以下示例显示如何使用HTTP > 创建OAuth 2.0请求模块以连接到Google。

  1. 请确保已创建项目、配置OAuth设置并生成凭据,如使用自定义OAuth客户端连接 Adobe Workfront Fusion 到 Google Services 中所述。

  2. 打开HTTP >发出OAuth 2.0请求模块。

  3. 单击连接框旁边的​ 添加

  4. 输入以下值:

    table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 layout-auto html-authored no-header
    连接名称 输入连接的名称。
    流类型 授权码
    授权URI https://accounts.google.com/o/oauth2/v2/auth
    令牌URI https://www.googleapis.com/oauth2/v4/token
    作用域 添加单个范围。 有关范围的更多信息,请参阅Google文档中的Google API的OAuth 2.O范围
    范围分隔符 空格
    客户端ID

    输入您的Google客户端ID。

    若要创建客户端ID,请参阅在Connect Adobe Workfront Fusion中使用自定义OAuth客户端创建Google Services的OAuth凭据。

    客户端密钥

    输入您的Google客户端密钥。

    要创建客户端密钥,请参阅Connect Adobe Workfront Fusion中使用自定义OAuth客户端创建Google服务的OAuth凭据。

    Authorize parameters

    添加access_type - offline 键值对。

    注意:如果您遇到身份验证问题,例如令牌刷新问题,请尝试添加prompt - consent 键值对。

  5. 单击​ 继续 ​以保存连接设置。

  6. 继续OAuth 2.0请求模块设置

有关通过HTTP > 发出OAuth 2.0请求模块连接到Microsoft Graph API的说明

有关Microsoft Graph API的说明,请参阅通过 Adobe Workfront Fusion HTTP调用 MS Graph REST API > 发出OAuth 2.0请求模块

OAuth 2.0请求模块设置

当您已建立Oauth 2.0连接(如为 OAuth 请求创建连接中所述),请根据需要继续设置模块。 所有授权令牌都会自动包含在此请求中,以及任何其他使用相同连接的请求中。

在配置HTTP >发出OAuth 2.0请求模块时,Workfront Fusion显示以下列出的字段。 模块中的粗体标题表示必填字段。

如果看到字段或函数上方的映射按钮,则可以使用该按钮设置该字段的变量和函数。 有关详细信息,请参阅在 Adobe Workfront Fusion中将信息从一个模块映射到另一个模块。

Connection
有关设置连接的信息,请参阅本文中的为OAuth请求创建连接
[!UICONTROL将所有状态计算为错误(2xx和3xx除外)

使用此选项可设置错误处理。

有关详细信息,请参阅Adobe Workfront Fusion中的错误处理。

URL
输入要向其发送请求的URL,如API端点、网站等。
方法

选择配置API调用所需的HTTP请求方法。 有关详细信息,请参阅Adobe Workfront Fusion中的HTTP请求方法。

Headers
以标准JSON对象的形式添加请求的标头。 例如, {"Content-type":"application/json"}
查询字符串
输入所需的查询键值对。
主体类型

HTTP正文是在HTTP事务消息中传输的数据字节,这些字节紧跟在标头之后(如果存在任何要使用的标头)。

  • Raw

    原始正文类型通常适用于大多数HTTP正文请求,即使在开发人员文档未指定要发送的数据的情况下也是如此。

    在内容类型字段中指定解析数据的形式。

    尽管选择了内容类型,但数据仍会以开发人员文档规定或要求的任何格式输入。

  • Application/x-www-form-urlencoded

    此正文类型将使用application/x-www-form-urlencodedPOST数据。

    对于application/x-www-form-urlencoded,发送到服务器的HTTP消息正文本质上是一个查询字符串。 键和值在以&分隔的键值对中进行编码,且键和值之间有=

    对于二进制数据,改为use multipart/form-data

    示例:

    生成的HTTP请求格式的示例:

    field1=value1&field2=value2

  • Multipart/form-data

    Multipart/form-data是用于发送文件和数据的HTTP多部分请求。 它通常用于将文件上传到服务器。

    添加要在请求中发送的字段。 每个字段必须包含一个键值对。

    • 文本

      输入要在请求正文中发送的键和值。

    • 文件

      输入密钥,并在请求正文中指定要发送的源文件。

      映射您要从上一个模块上传的文件(如HTTP >Get a File或Google Drive >Download a File),或手动输入文件名和文件数据。

解析响应

启用此选项可自动解析响应并转换JSON和XML响应,因此您无需使用JSON > Parse JSON或XML > Parse XML模块。

在使用解析的JSON或XML内容之前,请手动运行一次模块,以便模块能够识别响应内容并允许您在后续模块中映射该内容。

超时
输入请求超时,以秒为单位(1-300)。 默认值为40秒。
与其他HTTP模块共享Cookie
启用此选项可将来自服务器的Cookie与场景中的所有HTTP模块共享。
自签名证书
如果要使用自签名证书的TLS,请上载证书。
拒绝使用未验证(自签名)证书的连接
启用此选项可拒绝使用未经验证的TLS证书的连接。
遵循重定向
启用此选项可在3xx响应中遵循URL重定向。
遵循所有重定向
启用此选项后,URL重定向会带有所有响应代码。
禁用将多个相同的查询字符串键序列化为数组
默认情况下,Workfront Fusion处理与数组相同的URL查询字符串参数键的多个值。 例如,www.test.com?foo=bar&foo=baz将转换为www.test.com?foo[0]=bar&foo[1]=baz。 激活此选项以禁用此功能。
请求压缩内容

启用此选项可请求网站的压缩版本。

这会添加Accept-Encoding标头以请求压缩的内容。

使用双向TLS

启用此选项可在HTTP请求中使用双向TLS。

有关双方TLS的详细信息,请参阅在Adobe Workfront Fusion中的HTTP模块中使用双方TLS。

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43