Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix typo of PKCE #11707

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apisix/plugins/openid-connect.lua
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ local schema = {
public_key = {type = "string"},
token_signing_alg_values_expected = {type = "string"},
use_pkce = {
description = "when set to true the PKEC(Proof Key for Code Exchange) will be used.",
description = "when set to true the PKCE(Proof Key for Code Exchange) will be used.",
type = "boolean",
default = false
},
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ description: OpenID Connect(OIDC)是基于 OAuth 2.0 的身份认证协议
| token_endpoint_auth_method | string | 否 | | | 令牌端点的身份验证方法。该值应是 `token_endpoint_auth_methods_supported` [授权服务器元数据](https://www.rfc-editor.org/rfc/rfc8414.html)中指定的身份验证方法之一,如发现文档中所示,例如 `client_secret_basic`, `client_secret_post`, `private_key_jwt`,或 `client_secret_jwt`。如果不支持配置的方法,则回退到`token_endpoint_auth_methods_supported` 数组中的第一个方法。 |
| public_key | string | 否 | | | 验证令牌的公钥。 |
| use_jwks | boolean | 否 | false | | 当设置为 `true` 时,则会使用身份认证服务器的 JWKS 端点来验证令牌。 |
| use_pkce | boolean | 否 | false | [true, false] | 当设置为 `true` 时,则使用 PKEC(Proof Key for Code Exchange)。 |
| use_pkce | boolean | 否 | false | [true, false] | 当设置为 `true` 时,则使用 PKCE(Proof Key for Code Exchange)。 |
| token_signing_alg_values_expected | string | 否 | | | 用于对令牌进行签名的算法。 |
| set_access_token_header | boolean | 否 | true | [true, false] | 在请求头设置访问令牌。默认使用请求头参数 `X-Access-Token`。 |
| access_token_in_authorization_header | boolean | 否 | false | [true, false] | 当设置为 `true` 以及 `set_access_token_header` 也设置为 `true`时,将访问令牌设置在请求头参数 `Authorization`。 |
Expand Down
Loading