OAuth 2.0授权

创建身份验证配置

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

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

   这将身份验证配置模板添加公共到环境文件中，位于所选环境"Auth"下的对象中。"Security"例如：

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

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

4. 指定身份验证参数。所需身份的参数根据所选的填写"Grant Type"。验证参数时使用 PyCharm 编码帮助：开始输入参数名称或按获取可用 JSON 键的列表。CtrlSpace

   提示

   您还可以使用专用的实时模板：在下面"Auth"，开始输入auth并按。根据您在中选择的值，PyCharm 将所需字段添加到配置中。Enter"Grant Type"

   如果要快速添加可用于身份验证配置的所有参数，请按（显示上下文操作）并选择从 JSON 架构填写所有属性。AltEnter

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

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

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

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

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

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

动图

当您运行请求时，“服务”工具窗口中将提供“显示身份验证日志”按钮。它允许您查看重定向页面此类、访问令牌和其他身份验证详细信息。

手动获取访问令牌

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

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

   提示

   或者，将插入符号放在$auth.tokenHTTP请求中的变量上，按（显示上下文操作），然后获取选择或身份刷新验证令牌。AltEnter

2. 如果身份验证配置包含原生环境文件，请在出现的弹出窗口中选择原生环境文件。

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

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

获取新的访问令牌

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

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

2. 单击（显示上下文操作），然后选择强制获取身份验证令牌。AltEnter

3. 如果身份验证配置包含原生环境文件，请在出现的弹出窗口中选择原生环境文件。

当插入符号.http$auth.token文件中的变量上时，您可以调用相同的操作。在这种情况下，您不需要选择磁盘环境文件，HTTP客户端将位于与您的.http文件位于相同文件夹中的文件。

提示

授权服务器可能会将您的认证数据存储保存在内置JCEF浏览器的cookie中。在这种情况下，您将自动进行身份验证，并在cookie期间之前输入用户凭据。