管理 API 密钥
为了最大程度地降低API安全漏洞,Adobe Workfront管理员可以管理用于使应用程序能够代表用户访问Workfront的API密钥。
您可以重置或删除当前管理员API密钥,将API密钥配置为过期,以及删除所有用户的API密钥。
以下是利用Workfront API的应用程序示例:
- 记录Dropbox、Google Drive和Workfront DAM等集成
- Workfront移动应用程序
访问要求
您必须具有以下权限才能执行本文中的步骤:
table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
---|---|
Adobe Workfront计划 | 任何 |
Adobe Workfront许可证 | 计划 |
访问级别配置 |
您必须是Workfront管理员。 注意:如果您仍然没有访问权限,请咨询Workfront管理员是否对您的访问级别设置了其他限制。 有关Workfront管理员如何修改您的访问级别的信息,请参阅创建或修改自定义访问级别。 |
Workfront API密钥
Workfront中的每个用户都有一个唯一的API密钥。 当用户访问利用Workfront API的集成(例如Workfront移动应用程序或文档集成)时,将生成此密钥。
Workfront管理员还有唯一的API密钥。 当应用程序使用管理员API密钥访问Workfront时,该应用程序具有Workfront的管理员访问权限。
管理管理员API密钥
您可以为管理员用户帐户生成、重置或删除API密钥。
-
单击Adobe Workfront右上角的 主菜单 图标 ,或(如果可用)单击左上角的 主菜单 图标 ,然后单击 设置 。
-
单击 系统> 客户信息。
-
(视情况而定)执行以下操作之一:
要生成API密钥:在 API密钥设置 部分中,单击 生成API密钥。
或
要重置API密钥:在 API密钥设置 部分中,单击 重置,然后单击 重置。或
要删除API密钥:在 API密钥设置 部分中,单击 删除,然后单击 删除。
为非管理员用户生成API密钥
您可以为非Workfront管理员角色的用户生成和管理API密钥。
-
(视情况而定)如果您的组织使用单点登录(SSO)访问管理,请暂时禁用需要SSO身份验证的选项。
-
单击Adobe Workfront右上角的 主菜单 图标 ,或(如果可用)单击左上角的 主菜单 图标 ,然后单击 设置 。
-
展开 系统,然后单击 单点登录(SSO)。
-
在 类型 字段中,选择贵组织使用的SSO类型。
-
选定类型后,向下滚动并清除 启用 复选框。
-
单击 保存。
-
-
在浏览器的地址栏中,输入以下API调用:
<domain>
.my.workfront.com/attask/api/v7.0/user?action=generateApiKey&username= 用户名 &password= 密码**&method=PUT将
<domain>
替换为您的Workfront域名,并将用户名和密码替换为用户的Workfront凭据。 -
(视情况而定)如果在步骤1中禁用了SSO身份验证,请启用该选项。
-
单击Adobe Workfront右上角的 主菜单 图标 ,或(如果可用)单击左上角的 主菜单 图标 ,然后单击 设置 。
-
展开 系统,然后单击 单点登录(SSO)。
-
在 类型 下拉菜单中选择您的SSO方法。
-
选中要求SSO身份验证的复选框。
-
配置API密钥过期时间
您可以将API密钥配置为对系统中的所有用户过期。 当用户的API密钥过期时,用户必须向使用Workfront API访问Workfront的任何应用程序重新进行身份验证。 您可以更改API密钥的过期频率。 您还可以配置API密钥在用户密码过期时是否过期。
-
单击Adobe Workfront右上角的 主菜单 图标 ,或(如果可用)单击左上角的 主菜单 图标 ,然后单击 设置 。
-
单击 系统 > 客户信息。
-
在 API密钥设置 区域的 创建 后 API密钥在 下拉列表中过期,请选择希望API密钥过期的时间范围。
更改此选项时,新时间范围从您进行更改时开始。 例如,如果您将此选项从 1个月 更改为 6个月,则API密钥将在您进行更改后6个月过期。
默认情况下,API密钥每月过期。
-
若要将API密钥配置为在用户密码过期时过期,请选择 在用户密码过期时删除API密钥。
默认情况下,不选中此选项。
有关如何配置用户密码过期的信息,请参阅配置系统安全首选项。
-
单击 保存。
删除所有用户的API密钥
如果您担心您的Workfront系统存在特定的安全漏洞,则可以同时为所有用户删除API密钥。
-
单击Adobe Workfront右上角的 主菜单 图标 ,或(如果可用)单击左上角的 主菜单 图标 ,然后单击 设置 。
-
展开 系统,然后单击 客户信息。
-
在 API密钥设置 区域中,单击 删除所有API密钥,然后单击 删除 全部。
使用X.509证书限制API登录
第三方应用程序可以通过API与Workfront通信。 要提高Workfront站点的安全性,您可以通过将X.509证书上传到Workfront来将Workfront配置为限制API登录请求。 启用后,所有通过API的登录请求除了用户名和密码外,还必须包含客户端证书。
获取X.509证书 obtain-the-x-509-certificate
从受信任的证书颁发机构(如Verisign)获取有效的X.509证书,并将其放在工作站上的临时位置。
将证书上传到Workfront upload-the-certificate-to-workfront
从证书颁发机构获得X.509证书后,需要将其上传到Workfront。
-
单击Adobe Workfront右上角的 主菜单 图标 ,然后单击 设置 。
-
展开 系统,然后单击 客户信息。
-
在 API密钥设置 区域,选择 启用X.509证书。
-
在工作站上,浏览并选择您之前下载的X.509证书。
-
(可选)单击证书名称旁边的 查看详细信息 以查看有关证书的以下详细信息:
- 主题常用名
- 主题组织
- 主题组织单位
- 审批者常用名
- 审批者组织
- 审批者组织单位
- 序列号
- 审批日期
- 过期日期
-
单击 保存。
验证API登录调用是否受到限制 verify-api-login-calls-are-restricted
在将Workfront实例配置为需要X.509证书之前,请使用有效的用户名和密码参数对/login
端点执行API请求。 您将收到一个包含sessionID的200响应。
在通过Workfront实例中的客户信息页面要求登录X.509证书后,再次尝试登录。 此时,您将收到500错误响应,并显示以下消息:“不受信任的请求。 请联系您的系统管理员并附加证书。”
确认需要X.509证书后,执行相同的登录请求,并将apiCertificate的附加参数设置为证书的值。 如果正确执行了此操作,您将收到包含有效sessionID的200响应。