From 3466abff495875bd69ea3137aa8cd813b0dc55d2 Mon Sep 17 00:00:00 2001 From: Joseph Dougherty Date: Thu, 14 Jan 2021 17:55:50 -0500 Subject: [PATCH] DOCS-14079 add audit event for logout --- source/reference/audit-message.txt | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/source/reference/audit-message.txt b/source/reference/audit-message.txt index 99fd2df3763..5f0b2c3a675 100644 --- a/source/reference/audit-message.txt +++ b/source/reference/audit-message.txt @@ -656,6 +656,36 @@ associated ``param`` details and the ``result`` values, if any. - ``0`` - Success + + * - :authaction:`logout` + + - .. code-block:: none + :copyable: false + + { + reason: , + initialUsers: [ , ... ], + updatedUsers: [ , ... ], + } + + ``reason`` will be either: + - "Explicit logout from " + - "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]