提示
受到推崇的: 从 Work IQ 开发工具 开始,用于受支持的专业代码声明代理和插件方案。 请参阅 WIQD 快速入门。 基于工具包的说明仍然可用于需要它们的现有项目和工作流。 在选择工具之前,请检查 功能和目标体验支持 : WIQD 不面向自定义引擎代理。
某些 API 使用 API 密钥进行授权。 API 密钥是客户端包含在 API 请求中的共享密钥,用于进行身份验证和获取访问权限。 API 插件支持通过三种方式发送 API 密钥:
- 作为标头中的
Authorization持有者令牌 - 作为自定义标头中的值
- 作为查询参数
注意
对于声明性代理操作,API 密钥身份验证适用于从 OpenAPI 文档生成的 API 插件,而不是 MCP 插件。 对于代理的 MCP 插件,请使用 OAuth 2.0 (,包括动态客户端注册) 或 Microsoft Entra SSO。 包级远程 MCP 连接使用不同的配置;请参阅 应用清单中的身份验证。
分两步配置 API 密钥身份验证:将 API 密钥添加到 OpenAPI 文档,并创建 API 密钥身份验证配置。
步骤 1:将 API 密钥添加到 OpenAPI 文档
智能 智能 Microsoft 365 Copilot 副驾驶® 副驾驶® 根据 OpenAPI 文档中的条目确定securitySchemes如何发送 API 密钥。
持有者令牌
如果 API 接受 API 密钥作为持有者令牌,请在 OpenAPI 文档中启用持有者身份验证。 有关详细信息,请参阅 持有者身份验证。
securitySchemes:
BearerAuth:
type: http
scheme: bearer
自定义标头
如果 API 接受自定义标头中的 API 密钥,请在 OpenAPI 文档in中启用 API 密钥身份验证,并将属性设置为headername标头名称。 有关详细信息,请参阅 API 密钥。
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
查询参数
如果 API 接受查询参数中的 API 密钥,请通过将属性query设置为 和name属性设置为in查询参数的名称,在 OpenAPI 文档中启用 API 密钥身份验证。 有关详细信息,请参阅 API 密钥。
securitySchemes:
ApiKeyAuth:
type: apiKey
in: query
name: api_key
步骤 2:创建 API 密钥身份验证配置
API 密钥身份验证依赖于身份验证配置 (身份验证配置) - 存储在 Microsoft Enterprise 令牌存储中的记录,智能 智能 Microsoft 365 Copilot 副驾驶® 副驾驶®使用它在插件调用 API 时发送 API 密钥。 对于受支持的专业代码项目,从 WIQD 开始。 工具包和 Microsoft Teams 开发人员门户过程仍可作为替代方案使用。 声明性代理开发人员技能不支持 API 密钥身份验证,因为它生成 MCP 插件。
使用 Work IQ 开发工具 (推荐)
对于现有的 API 插件清单,wiqd agent add auth请与 --plugin-manifest、 和 --auth-name--auth-type api-key一起使用。 设置为 --api-key-inheader 或 query 和 --api-key-name 设置为 OpenAPI 安全方案中的名称。 如果 API 接受其密钥作为持有者令牌,请选择 --auth-type bearer-token。
从 OpenAPI 文档添加操作时, wiqd agent add action 接受 --api-key API 密钥或持有者凭据。 省略该值时,该命令记录环境占位符。 按照所选命令的凭据处理并完成项目的预配工作流。 这些 API 密钥选项不会为代理的 MCP 插件建立 API 密钥支持。
使用 Microsoft 365 代理工具包
从 Microsoft 365 智能体工具包中的现有 OpenAPI 文档创建 API 插件时,该工具包将注册 API 密钥、创建身份验证配置,并更新插件清单。 必须在 OpenAPI 文档中定义该 securitySchemes 属性。
使用 Teams 开发人员门户
如果使用 Agents Toolkit,则可以选择在 Teams 开发人员门户中注册。 使用它来手动创建身份验证配置,或管理 Agents Toolkit 已创建的身份验证配置。
打开 Teams 开发人员门户。 选择 “工具” ->“API 密钥注册”。
如果没有现有注册,请选择 “创建 API 密钥”。 如果已有注册,请选择“ 新建 API 密钥”。
选择“ 添加机密 ”并输入 API 密钥。
填写以下字段。
- API 密钥名称:注册的友好名称。
-
基 URL:API 的基本 URL。 此值应对应于 OpenAPI 文档中数组中的
servers条目。 - 目标租户:限制对主租户的 API 访问,或允许任何租户。
- 目标 Teams 应用:如果不知道最终应用 ID,请选择 “任何 Teams 应用 ”。 发布应用后,将此注册与已发布的应用 ID 绑定。
选择“保存”。
完成注册会生成一个 身份验证配置 ID (Teams 开发人员门户中当前标记为 API 密钥的注册 ID) 。
将身份验证配置 ID 添加到插件清单
在 Teams 开发人员门户中手动创建身份验证配置时,请type将运行时身份验证对象ApiKeyPluginVault的属性设置为 ,并将 设置为reference_id身份验证配置 ID。 Agents Toolkit 可为你执行此操作。
"auth": {
"type": "ApiKeyPluginVault",
"reference_id": "auth config ID"
},