Skip to content

Commit 669dc9b

Browse files
jmd-mongoandf-mongodb
authored andcommitted
DOCS-14079 add audit event for logout
1 parent a086bf4 commit 669dc9b

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

source/reference/audit-message.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -656,6 +656,36 @@ associated ``param`` details and the ``result`` values, if any.
656656

657657

658658
- ``0`` - Success
659+
660+
* - :authaction:`logout`
661+
662+
- .. code-block:: none
663+
:copyable: false
664+
665+
{
666+
reason: <string>,
667+
initialUsers: [ <document>, ... ],
668+
updatedUsers: [ <document>, ... ],
669+
}
670+
671+
``reason`` will be either:
672+
- "Explicit logout from <database>"
673+
- "Implicit logout due to client connection closure"
674+
675+
``initialUsers`` is an array of documents containing users
676+
authenticated on the current client prior to logout.
677+
678+
``updatedUsers`` is an array of documents containing users
679+
expected to be authenticated on the current client after the
680+
logout event.
681+
682+
Each document in ``initialUsers`` and ``updatedUsers`` contains:
683+
- ``user``: the username
684+
- ``db``: the database ``user`` is authenticated to
685+
686+
.. versionadded:: 5.0
687+
688+
- ``0`` - Success
659689

660690

661691
.. [#performance]

0 commit comments

Comments
 (0)