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: update the description of session lifetime in openid-connect.md #10994

Merged
merged 12 commits into from
Mar 7, 2024
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/openid-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ description: OpenID Connect allows the client to obtain user information from th
| session | object | False | | | When bearer_only is set to false, openid-connect will use Authorization Code flow to authenticate on the IDP, so you need to set the session-related configuration. |
| session.secret | string | True | Automatic generation | 16 or more characters | The key used for session encrypt and HMAC operation. |
| session.cookie | object | False | | | |
| session.cookie.lifetime | integer | False | 3600 | | it holds the cookie lifetime in seconds in the future. By default this is set to 3,600 seconds. This can be configured with Nginx set $session_cookie_lifetime 3600;. This does not set cookie's expiration time on session only (by default) cookies, but it is used if the cookies are configured persistent with session.cookie.persistent == true. |
| session.cookie.lifetime | integer | False | 3600 | | Cookie lifetime in seconds. |
| unauth_action | string | False | "auth" | ["auth","deny","pass"] | Specify the response type on unauthenticated requests. "auth" redirects to identity provider, "deny" results in a 401 response, "pass" will allow the request without authentication. |
| proxy_opts | object | False | | | HTTP proxy that the OpenID provider is behind. |
| proxy_opts.http_proxy | string | False | | http://proxy-server:port | HTTP proxy server address. |
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 @@ -61,7 +61,7 @@ description: OpenID Connect(OIDC)是基于 OAuth 2.0 的身份认证协议
| session | object | 否 | | | 当设置 bearer_only 为 false 时,openid-connect 插件将使用 Authorization Code 在 IDP 上进行认证,因此你必须设置 session 相关设置。 |
| session.secret | string | 是 | 自动生成 | 16 个以上字符 | 用于 session 加密和 HMAC 计算的密钥。 |
| session.cookie | object | False | | | |
| session.cookie.lifetime | integer | False | 3600 | | 用于设置 cookie 的生命周期,以秒为单位。默认设置为 3600 秒。这可以通过 Nginx `set $session_cookie_lifetime 3600` 来配置。在默认情况下不会影响会话 cookie 的过期时间,但如果通过 session.cookie.persistent == true 配置了持久化的 cookie,则会使用该值。另请参阅有关 ssl_session_timeout 的说明。 |
| session.cookie.lifetime | integer | False | 3600 | | 用于设置 cookie 的生命周期,以秒为单位。 |
| unauth_action | string | False | "auth" | ["auth","deny","pass"] | 指定未经身份验证的请求的响应类型。 `auth` 重定向到身份提供者,`deny` 导致 401 响应,`pass` 将允许请求而无需身份验证。 |
| proxy_opts | object | 否 | | | OpenID 服务器前面的 HTTP 代理服务器。 |
| proxy_opts | object | 否 | | | 用来访问身份认证服务器的代理服务器。 |
Expand Down
Loading