Skip to content

Commit

Permalink
Review#3: handle docs review feedback.
Browse files Browse the repository at this point in the history
  • Loading branch information
azasypkin committed Mar 22, 2021
1 parent 36248cc commit 62c446c
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 9 deletions.
4 changes: 1 addition & 3 deletions docs/api/session-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
[[session-management-api]]
== {kib} user session management APIs

Allows managing {kib} <<xpack-security-session-management, user sessions>>.

The following {kib} user session management APIs are available:
The following <<xpack-security-session-management, {kib} user session>> management APIs are available:

* <<session-management-api-invalidate, Invalidate user sessions API>> to invalidate {kib} user sessions

Expand Down
8 changes: 4 additions & 4 deletions docs/api/session-management/invalidate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ To use the invalidate sessions API, you must be a `superuser`.
==== Request body

`match`::
(Required, string) Specifies how {kib} should determine which sessions should be invalidated. Can either be `all` to invalidate all existing sessions, or `query` to only invalidate sessions that match the query specified in the additional `query` parameter.
(Required, string) Specifies how {kib} determines which sessions to invalidate. Can either be `all` to invalidate all existing sessions, or `query` to only invalidate sessions that match the query specified in the additional `query` parameter.

`query`::
(Optional, object) Specifies the query that {kib} should use to match the sessions that should be invalidated when `match` parameter is set to `query`. This parameter is forbidden if `match` is set to `all`.
(Optional, object) Specifies the query that {kib} uses to match the sessions to invalidate when the `match` parameter is set to `query`. You cannot use this parameter if `match` is set to `all`.
+
.Properties of `query`
[%collapsible%open]
=====
`provider` :::
(Required, object) Describes the <<authentication-security-settings, authentication provider(s)>> for which to invalidate sessions.
(Required, object) Describes the <<authentication-security-settings, authentication providers>> for which to invalidate sessions.
`type` ::::
(Required, string) The authentication provider `type`.
Expand All @@ -55,7 +55,7 @@ To use the invalidate sessions API, you must be a `superuser`.
Indicates a successful call.

`403`::
Indicates that the user may not be authorized to invalidate sessions for other users, refer to <<session-management-api-invalidate-prereqs, Prerequisite section>>.
Indicates that the user may not be authorized to invalidate sessions for other users. Refer to <<session-management-api-invalidate-prereqs, prerequisites>>.

==== Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/user/security/authentication/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ For more information, refer to <<embedding, Embed {kib} content in a web page>>.

{kib} maintains a separate <<xpack-security-session-management, session>> for every anonymous user, as it does for all other authentication mechanisms.

You can configure both <<session-idle-timeout, session idle timeout>> and <<session-lifespan, session lifespan>> for the anonymous sessions as you'd do for any other session with the only exception that idle timeout is explicitly disabled for the anonymous sessions by default. That means that the global <<security-session-and-cookie-settings, `xpack.security.session.idleTimeout`>> setting won't affect anonymous sessions. If you want to change the idle timeout for the anonymous sessions, you must configure the provider-level <<anonymous-authentication-provider-settings, `xpack.security.authc.providers.anonymous.<provider-name>.session.idleTimeout`>> setting instead.
You can configure <<session-idle-timeout, session idle timeout>> and <<session-lifespan, session lifespan>> for anonymous sessions the same as you do for any other session with the exception that idle timeout is explicitly disabled for anonymous sessions by default. The global <<security-session-and-cookie-settings, `xpack.security.session.idleTimeout`>> setting doesn't affect anonymous sessions. To change the idle timeout for anonymous sessions, you must configure the provider-level <<anonymous-authentication-provider-settings, `xpack.security.authc.providers.anonymous.<provider-name>.session.idleTimeout`>> setting.

[[http-authentication]]
==== HTTP authentication
Expand Down
2 changes: 1 addition & 1 deletion docs/user/security/session-management.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ When you log in, {kib} creates a session that is used to authenticate subsequent

When your session expires, or you log out, {kib} will invalidate your cookie and remove session information from the index. {kib} also periodically invalidates and removes any expired sessions that weren't explicitly invalidated.

To manage user sessions programmatically, {kib} exposes a set of <<session-management-api, session management APIs>>.
To manage user sessions programmatically, {kib} exposes <<session-management-api, session management APIs>>.

[[session-idle-timeout]]
==== Session idle timeout
Expand Down

0 comments on commit 62c446c

Please sign in to comment.