Skip to content

DOCS-14079 add audit event for logout #4813

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

Merged
Merged
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
30 changes: 30 additions & 0 deletions source/reference/audit-message.txt
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,36 @@ associated ``param`` details and the ``result`` values, if any.


- ``0`` - Success

* - :authaction:`logout`

- .. code-block:: none
:copyable: false

{
reason: <string>,
initialUsers: [ <document>, ... ],
updatedUsers: [ <document>, ... ],
}

``reason`` will be either:
- "Explicit logout from <database>"
- "Implicit logout due to client connection closure"

``initialUsers`` is an array of documents containing users
authenticated on the current client prior to logout.

``updatedUsers`` is an array of documents containing users
expected to be authenticated on the current client after the
logout event.

Each document in ``initialUsers`` and ``updatedUsers`` contains:
- ``user``: the username
- ``db``: the database ``user`` is authenticated to

.. versionadded:: 5.0

- ``0`` - Success


.. [#performance]
Expand Down