HTTP > 发出OAuth 2.0请求模块
要向需要OAuth 2.0授权的服务器发出Adobe Workfront Fusion HTTP(S)请求,您首先需要创建OAuth连接。 Adobe Workfront Fusion确保通过此连接进行的所有调用都具有适当的授权标头,并在需要时自动刷新关联的令牌。
Workfront Fusion支持以下OAuth 2.0身份验证流程:
- 授权代码流程
- 隐式流
其他流(如资源所有者密码凭据流和客户端凭据流)不自动支持通过此模块运行。
有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架。
访问要求
您必须具有以下权限才能使用本文中的功能:
table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header | |
---|---|
Adobe Workfront包 | 任何 |
Adobe Workfront许可证 |
新增:标准 或 当前:工作或更高 |
Adobe Workfront Fusion许可证** |
当前:无Workfront Fusion许可证要求。 或 旧版:Workfront Fusion for Work Automation and Integration |
产品 |
新增:
或 当前:您的组织必须购买Adobe Workfront Fusion。 |
有关此表中信息的更多详细信息,请参阅文档🔗中的访问要求。
有关Adobe Workfront Fusion许可证的信息,请参阅Adobe Workfront Fusion 许可证。
为OAuth请求创建连接
有关在HTTP > 发出OAuth 2.0请求模块中创建连接的一般说明
-
在target服务中创建要Adobe Workfront Fusion与之通信的OAuth客户端。 该选项最有可能在给定服务的开发人员部分找到。
-
创建客户端时,在
Redirect URL
或Callback 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个密钥:
Client ID
和Client Secret
。 某些服务调用这些App Key
和App Secret
。 将密钥和秘密保存到安全位置,以便您可以在Workfront Fusion中创建连接时提供它们。
-
-
在给定服务的API文档中查找
Authorize URI
和Token URI
。 这些是Workfront Fusion与target服务通信的URL地址。 这些地址用于OAuth授权。note note NOTE 如果服务使用隐式流,则您只需要 Authorize URI
。 -
(视情况而定)如果目标服务使用作用域(访问权限),请检查服务如何分隔各个作用域,并确保在高级设置中相应地设置分隔符。 如果未正确设置分隔符,Workfront Fusion将无法创建连接,并且您会收到无效的范围错误。
-
完成上述步骤后,即可开始在Workfront Fusion中创建OAuth连接。 添加HTTP >向方案发出OAuth 2请求模块。
-
在模块的“连接”字段中,单击 添加。
-
填写以下字段以创建连接:
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 17-row-2 18-row-2 layout-auto html-authored no-header 连接名称 输入连接的名称。 环境 选择您使用的是生产环境还是非生产环境。 类型 选择您使用的是服务帐户还是个人帐户。 流类型 选择获取令牌的流程。
- 授权代码:输入服务的API文档中的
Authorize URI
和Token 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_type:
authorization_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_basic
和client_secret_post
)。 Workfront Fusion通过client_secret_post
方法自动发送指定的客户端ID和密码。 因此,这些参数会自动包含在令牌请求正文中。有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架。
刷新令牌参数 添加要包含在令牌调用中的任何参数。 以下标准参数始终自动包含在内,无需添加。
标准参数:
-
grant_type:
refresh_token
-
refresh_token:您连接到的服务所获得的最新刷新令牌
-
client_id:创建帐户时收到的客户端ID会自动包含在请求正文中
-
client_secret:创建帐户时收到的客户端密钥会自动包含在请求正文中
注意:
OAuth 2.0标准在此步骤中支持至少2种客户端身份验证方法(
client_secret_basic
和client_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_basic
和client_secret_post
)。 Workfront Fusion不自动支持client_secret_basic
方法。 如果您连接的服务要求将客户端ID和客户端密钥组合为一个字符串,然后将base64编码到授权标头,则您应在此处添加该标头和密钥值。有关OAuth 2.0身份验证的更多信息,请参阅OAuth 2.0授权框架。
令牌放置 选择在连接到指定的URL时是在标头、查询字符串中发送令牌,还是同时在这两种情况下发送令牌。
令牌最常在请求标头中发送。
标头令牌名称 在标头中输入授权令牌的名称。 默认值: Bearer
。查询字符串参数名称 在查询字符串中输入授权令牌的名称。 默认值: access_token
。 - 授权代码:输入服务的API文档中的
-
单击 继续 保存连接并返回模块。
有关在HTTP > 创建OAuth 2.0请求模块中创建与Google的连接的说明
以下示例显示如何使用HTTP > 创建OAuth 2.0请求模块以连接到Google。
-
请确保已创建项目、配置OAuth设置并生成凭据,如Connect Adobe Workfront Fusion to Google Services 文章中所述,使用自定义OAuth客户端。
-
打开HTTP > 发出OAuth 2.0请求模块。
-
在任意模块中,单击“连接”框旁边的 添加。
-
输入以下值:
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 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
键值对。 -
单击 继续 以保存连接设置。
配置Make an OAuth 2.0请求模块
建立OAuth 2.0连接后,继续根据需要设置模块。 所有授权令牌都会自动包含在此请求中,以及任何其他使用相同连接的请求中。
在配置HTTP > 发出OAuth 2.0请求模块时,Workfront Fusion显示以下列出的字段。 模块中的粗体标题表示必填字段。
如果看到字段或函数上方的映射按钮,则可以使用该按钮设置该字段的变量和函数。 有关详细信息,请参阅在 Adobe Workfront Fusion中将信息从一个模块映射到另一个模块。