endSessions
On this page
This version of the documentation is archived and no longer
supported. View the current documentation to learn how to
upgrade your version of MongoDB.
Definition
endSessions
New in version 3.6.
The
endSessions
command expires the specified sessions. The command overrides the timeout period that sessions wait before expiring.endSessions
has the following syntax:{ endSessions: [ { id : <UUID> }, ... ] } ) To run
endSessions
, use thedb.runCommand( { <command> } )
method.db.runCommand( { endSessions: [ { id : <UUID> }, ... ] } )
Behavior
Session Identification
MongoDB concatenates each of the specified UUIDs with the hash of the
authenticated user credentials to identify the user's sessions to end.
If the user has no session that match, the endSessions
has no effect.
Access Control
If the deployment enforces authentication/authorization, you must be
authenticated to run the endSessions
command.
A user can only end sessions belonging to the user.