OAuth 2.0 授权

创建身份验证配置

1. 在 .http 文件中，在 使用以下方式运行 列表中，选择要添加身份验证配置的环境。

2. 在工具栏中，点击 并选择 身份验证配置。

   这会在所选环境的 "Security" 下的 "Auth" 对象中，向公共环境文件添加一个身份验证配置模板。 例如：

   { "dev": { "Security": { "Auth": { "auth-id": { "Type": "OAuth2", "Grant Type": "", "Client ID": "" } } } } }

3. 将占位符 auth-id 替换为有意义的名称，您将在 .http 文件中使用该名称引用此配置。

4. 指定 身份验证参数。 所需参数取决于所选 "Grant Type"。 在填写身份验证参数时，请使用 PyCharm 编码辅助：开始键入参数名称，或按 Ctrl+Space 以获取可用 JSON 键的列表。

在 HTTP 请求中使用身份验证配置

创建身份验证配置后，您可以使用它获取访问令牌，并对请求进行身份验证。

1. 将身份验证配置的名称传递给 {{$auth.token()}} 变量，例如， {{$auth.token("my-config")}}。 您可以在请求 Authorization 标头或查询参数中使用此变量。

2. 点击 以发送请求。 在访问受保护资源之前，HTTP 客户端会向授权服务器发送请求以获取访问令牌。

3. 当出现提示时，完成身份验证过程。 如果身份验证成功完成，HTTP 客户端将访问受保护的资源。

要快速添加 {{$auth.token()}} 变量，您可以使用实时模板：在 HTTP 方法下的标头部分，开始键入 AuthorizationToken ，并从出现的建议列表中选择可用的身份验证。

运行此类请求时， 显示身份验证日志 按钮将在 服务 工具窗口中可用。 它可让您查看重定向页面、访问令牌以及其他身份验证详细信息。

手动获取访问令牌

当您在 HTTP 请求中引用身份验证配置时，HTTP 客户端会在访问受保护资源之前自动获取（或刷新）访问令牌。 如果您希望在不向受保护资源发送实际请求的情况下获取访问令牌，您可以手动获取访问令牌。

1. 在 http-client.env.json 文件中，点击身份验证配置名称旁边的 。

2. 如果身份验证配置包含 私有变量 ，请在出现的弹出窗口中选择一个私有环境文件。

3. 当出现提示时，完成身份验证过程。

如果身份验证成功完成，PyCharm 将获取访问令牌。 如果您已经拥有访问令牌，但该令牌已过期，PyCharm 将刷新它。

获取新访问令牌

除了刷新令牌之外，您还可以通过重新进行身份验证来获取新令牌，即重复用于获取初始访问令牌的原始流程。

1. 在 http-client.env.json 文件中，将插入符号置于身份验证配置名称上。

2. 按 Alt+Enter (显示上下文操作 )，并选择 强制获取身份验证令牌。

3. 如果身份验证配置包含 私有变量 ，请在出现的弹出窗口中选择一个私有环境文件。

当您的插入符号位于 .http 文件中的 $auth.token 变量上时，您可以调用相同的操作。 在这种情况下，您无需选择私有环境文件，因为 HTTP 客户端会使用与您的 .http 文件位于同一文件夹中的该文件。

清除浏览器 Cookie

您的授权服务器可能会将身份验证数据存储在浏览器的 Cookie 中。 如果您想使用不同的数据测试身份验证流程，可能需要清除内置 JCEF 浏览器的 Cookie。

1. 在 http-client.env.json 文件中，将插入符号置于身份验证配置名称上，并按 Alt+Enter (显示上下文操作)。

2. 选择 清除浏览器 Cookie。

或者，您可以在 HTTP 客户端身份验证日志 工具窗口中点击 来清除 Cookie。

使用 ID 令牌替代访问令牌

如果您的服务器要求使用 ID 令牌而不是访问令牌，您可以通过以下任一方式配置 HTTP 客户端以实现此目的：

• 在您的身份验证配置中，使用 "Use ID Token": true 参数。

• 在 .http 文件中，使用 $auth.idToken 变量，例如， Authorization: Bearer {{$auth.idToken("auth-id-1")}}。

使用自定义身份验证参数

HTTP 客户端提供定义自定义请求参数的选项，您的授权服务器可能需要这些参数。 例如，包括扩展 OAuth 2.0 授权框架的 resource 和 audience。

1. 在您的身份验证配置中，添加 "Custom Request Parameters" 对象。

2. 在 "Custom Request Parameters" 内，输入参数名称和值（字符串或数组）。

3. 如果您想将参数的使用限制为某些请求，请将该值定义为包含两个键的对象：

   • "Value" (参数值)

   • "Use" — 参数的使用范围。 它有三种可能的取值：

     • "Use": "Everywhere" (在任何请求中)

     • "Use": "In Auth Request" (仅在身份验证请求中)

     • "Use": "In Token Request" (仅在令牌请求中)

   例如：

   "auth-id-1": { "Type": "OAuth2", "Custom Request Parameters": { "audience": { "Value": "https://my-audience.com/", "Use": "In Token Request" }, "resource": [ "https://my-resource/resourceId1", "https://my-resource/resourceId2" ], "my-custom-parameter": "my-custom-value" }, }

使用 HTTP 客户端身份验证日志 工具窗口查看请求中使用的参数及其值。

使用自定义请求标头

HTTP 客户端提供使用自定义请求标头的选项，您的授权服务器可能需要这些标头。

1. 在您的身份验证配置中，添加 "Custom Request Headers" 对象。

2. 在 "Custom Request Headers" 内，输入标头名称及其值。

   按 Ctrl+Space 可获取常用标头的建议列表，例如 Accept、 Cookie 或 User-Agent。

3. 如果您想将标头的使用限制为某些请求，请将该值定义为包含两个键的对象：

   • "Value" (标头值)

   • "Use" — 标头的使用范围。 它有三种可能的取值：

     • "Use": "Everywhere" (在任何请求中)

     • "Use": "In Auth Request" (仅在身份验证请求中)

     • "Use": "In Token Request" (仅在令牌请求中)

   例如：

   "auth-id-1": { "Type": "OAuth2", "Custom Request Headers": { "Accept": { "Use": "Everywhere", "Value": "application/javascript" }, "my-custom-header": "my-custom-value" }, }