- Reference >
- Database Commands >
- Administration Commands >
- connectionStatus
connectionStatus¶
On this page
New in version 2.4.0.
Definition¶
- connectionStatus¶
Returns information about the current connection, specifically the state of authenticated users and their available permissions.
Output¶
- connectionStatus.authInfo¶
A document with data about the authentication state of the current connection, including users and available permissions.
- connectionStatus.authinfo.authenticatedUsers¶
An array with documents for each authenticated user.
- connectionStatus.authInfo.authenticatedUsers[n].user¶
The user’s name.
- connectionStatus.authInfo.authenticatedUsers[n].db¶
The database associated with the user’s credentials.
- connectionStatus.authinfo.authenticatedUserRoles¶
An array with documents for each role granted to the current connection:
- connectionStatus.authinfo.authenticatedUserRoles[n].role¶
The definition of the current roles associated with the current authenticated users. See Built-In Roles and Privilege Actions for more information.
- connectionStatus.authinfo.authenticatedUserRoles[n].db¶
The database to which role applies.
- connectionStatus.ok¶
The return value for the command. A value of 1 indicates success.