connectionStatus

Definition

  • connectionStatus
  • Returns information about the current connection, specifically thestate of authenticated users and their available permissions.
  1. { connectionStatus: 1, showPrivileges: <boolean> }

connectionStatus supports the following optionalfield:

FieldTypeDescriptionshowPrivilegesbooleanOptional. Set showPrivileges to true to instructconnectionStatus to return the full set ofprivileges thatcurrently-authenticated users possess.

By default, this field is false.

Example

To run connectionStatus use the db.runCommand()method, as in the following:

  1. db.runCommand( { connectionStatus: 1, showPrivileges: true } )

Output

  • connectionStatus.authInfo
  • A document with data about the authentication state of the currentconnection, 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 currentauthenticated users. See Built-In Roles andPrivilege Actions for more information.

    • connectionStatus.authinfo.authenticatedUserRoles[n].db

    • The database to whichroleapplies.
  • connectionStatus.authInfo.authenticatedUserPrivileges

  • An array with documents describing the actions granted to the current connection,grouped by resource.

    • connectionStatus.authInfo.authenticatedUserPrivileges[n].resource

    • A document describing the database and, if applicable, collectionto whichconnectionStatus.authInfo.authenticatedUserPrivileges[n].actionsapplies.

    • connectionStatus.authInfo.authenticatedUserPrivileges[n].actions

    • An array listing the privilege actions thatthe connection has access to for the specified resource.
  • connectionStatus.ok
  • The return value for the command. A value of 1 indicatessuccess.