rolesInfo (comando de base de datos)

Definición

rolesInfo

Devuelve información de herencia y privilegios para roles específicos, incluidos ambos Roles definidos por el usuario y roles integrados.

El comando también puede recuperar todos los roles incluidos en una base de rolesInfo datos.

Compatibilidad

Este comando está disponible en implementaciones alojadas en los siguientes entornos:

• MongoDB Atlas: El servicio totalmente gestionado para implementaciones de MongoDB en la nube

• MongoDB Enterprise: La versión basada en suscripción y autogestionada de MongoDB

• MongoDB Community: La versión de MongoDB con código fuente disponible, de uso gratuito y autogestionada.

Sintaxis

El comando tiene la siguiente sintaxis:

db.runCommand(
   {
     rolesInfo: { role: <name>, db: <db> },
     showAuthenticationRestrictions: <Boolean>,
     showBuiltinRoles: <Boolean>,
     showPrivileges: <Boolean>,
     comment: <any>
   }
)

Campos de comandos

El comando toma los siguientes campos:

Comportamiento

{ rolesInfo: "<rolename>" }

{ rolesInfo: { role: "<rolename>", db: "<database>" } }

{
  rolesInfo: [
     "<rolename>",
     { role: "<rolename>", db: "<database>" },
     ...
  ]
}

{ rolesInfo: 1, showBuiltinRoles: true }

Acceso requerido

Para ver la información de un rol, debe tener el rol otorgado explícitamente o debe tener la viewRole acción en la base de datos del rol.

Salida

rolesInfo.role

El nombre del rol.

rolesInfo.db

La base de datos donde se define el rol. Cada base de datos tiene roles predefinidos. Una base de datos también puede tener roles definidos por el usuario.

rolesInfo.isBuiltin

Un valor de true indica que el rol es un rol integrado. Un valor de false indica que el rol es un rol definido por el usuario.

rolesInfo.roles

Los roles que proporcionan privilegios directamente a este rol y las bases de datos en las que se definen los roles.

rolesInfo.inheritedRoles

Todos los roles de los que este rol hereda privilegios. Esto incluye los roles de la matriz, así como los roles rolesInfo.roles rolesInfo.roles de los que los roles de la matriz heredan privilegios. Todos los privilegios se aplican al rol actual. Los documentos de este campo enumeran los roles y las bases de datos en las que están definidos.

rolesInfo.privileges

Los privilegios especificados directamente por este rol; es decir, la matriz excluye los privilegios heredados de otros roles. Por defecto, la salida no incluye el campo. Para incluirlo,privileges especifique showPrivileges: true al ejecutar el rolesInfo comando.

Cada documento de privilegio especifica los recursos y las acciones permitidas sobre los recursos.

rolesInfo.inheritedPrivileges

Todos los privilegios otorgados por este rol, incluidos los heredados de otros roles. De forma predeterminada, la salida no incluye el inheritedPrivileges campo. Para incluirlo, especifique showPrivileges: true al ejecutar el rolesInfo comando.

Cada documento de privilegio especifica los recursos y las acciones permitidas sobre los recursos.

Ejemplos

Los ejemplos de esta sección muestran cómo utilizar el comando rolesInfo para:

• Ver información para un rol individual

• Ver información para múltiples roles

• Ver todos los roles definidos por el usuario para una base de datos

• Ver todos los roles definidos por el usuario e integrados para una base de datos

• Ver restricciones de autenticación para roles

db.runCommand(
    {
      rolesInfo: { role: "associate", db: "products" }
    }
)

db.runCommand(
    {
      rolesInfo: "siteManager"
    }
)

db.runCommand(
    {
      rolesInfo: { role: "associate", db: "products" },
      showPrivileges: true
    }
)

db.runCommand(
    {
      rolesInfo: [
         { role: "associate", db: "products" },
         { role: "manager", db: "resources" }
      ]
    }
)

db.runCommand(
    {
      rolesInfo: [
         { role: "associate", db: "products" },
         { role: "manager", db: "resources" }
      ],
      showPrivileges: true
    }
)

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

{
  roles: [
    {
      _id: 'products.associate',
      role: 'associate',
      db: 'products',
      privileges: [
        {
          resource: { db: 'products', collection: '' },
          actions: [ 'bypassDocumentValidation' ]
        }
      ],
      roles: [ { role: 'readWrite', db: 'products' } ],
      isBuiltin: false,
      inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
      inheritedPrivileges: [
        {
          resource: { db: 'products', collection: '' },
          actions: [ 'bypassDocumentValidation' ]
        },
        {
          resource: { db: 'products', collection: '' },
          actions: [
            'changeStream',
            'collStats',
            'compactStructuredEncryptionData',
            ...
          ]
        },
        ...
      ]
    }
  ],
  ok: 1
}

db.runCommand(
    {
      rolesInfo: 1,
      showBuiltinRoles: true
    }
)

{
  roles: [
    {
      role: 'enableSharding',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    {
      role: 'userAdmin',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    {
      role: 'read',
      db: 'products',
      isBuiltin: true,
      roles: [],
      inheritedRoles: []
    },
    ...
  ],
  ok: 1
}

db.runCommand(
    {
      rolesInfo: 1,
      showAuthenticationRestrictions: true
    }
)

{
  roles: [
    {
      _id: 'products.associate',
      role: 'associate',
      db: 'products',
      roles: [ { role: 'readWrite', db: 'products' } ],
      authenticationRestrictions: [
        [ { clientSource: [ '198.51.100.0' ] } ]
      ],
      isBuiltin: false,
      inheritedRoles: [ { role: 'readWrite', db: 'products' } ],
      inheritedAuthenticationRestrictions: [
        [ { clientSource: [ '198.51.100.0' ] } ]
      ]
    }
  ],
  ok: 1
}