Devolver todos los usuarios de la base de datos en un proyecto

Obtener /api/atlas/v1.0/grupos/{ID de grupo}/usuarios de la base de datos

Devuelve todos los usuarios de la base de datos que pertenecen al proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.

Parámetros de ruta

  • ID de grupo string Requerido

    Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.

    NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

    El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

Parámetros de consulta

  • envolvente booleano

    Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.

    El valor predeterminado es false.

  • incluirConteo booleano

    Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en la respuesta.

    El valor predeterminado es true.

  • artículos por página entero

    Número de elementos que la respuesta devuelve por página.

    El valor mínimo es 1, el valor máximo es 500. El valor predeterminado es 100.

  • número de página entero

    Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

    El valor mínimo es 1. El valor por defecto es 1.

  • bonita booleano

    Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.

    El valor predeterminado es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • resultados matriz[objeto]

      Lista de documentos devueltos que MongoDB nube proporciona al completar esta solicitud.

      Ocultar atributos de resultados Mostrar atributos de resultados Objeto
      • awsIAMType string

        Etiqueta legible por humanos que indica si el nuevo usuario de la base de datos se autentica con las credenciales de administración de identidad y acceso (IAM) de Amazon Web Services (AWS) asociadas con el usuario o el rol del usuario.

        Los valores son NONE, USER o ROLE. El valor predeterminado es NONE.

      • nombreDeBaseDeDatos string Requerido

        La base de datos en la que se autentica el usuario. Los usuarios de la base de datos deben proporcionar un nombre de usuario y una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP u OIDC Workload, este valor debe ser $external. Si se autentica con SCRAM-SHA u OIDC Workforce, este valor debe ser admin.

        Los valores son admin o $external. El valor predeterminado es admin.

      • eliminarDespuésDeFecha cadena(fecha-hora)

        Fecha y hora en que MongoDB Cloud elimina al usuario. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC y puede incluir la designación de la zona horaria. Debe especificar una fecha futura que caiga dentro de una semana después de realizar la solicitud de la API.

      • Descripción string

        Descripción de este usuario de base de datos.

        La longitud máxima es 100.

      • Etiquetas matriz[objeto]

        Lista que contiene los pares clave-valor para etiquetar y categorizar el usuario de la base de datos MongoDB. Las etiquetas que defina no aparecen en la consola.

        Etiquetas legibles por humanos aplicadas a este componente de MongoDB Cloud.

        Ocultar atributos de etiquetas Mostrar atributos de etiquetas Objeto
        • clave string

          Clave aplicada para etiquetar y categorizar este componente.

          La longitud mínima es 1, la longitud máxima es 255.

        • valor string

          Valor establecido en la clave aplicada para etiquetar y categorizar este componente.

          La longitud mínima es 1, la longitud máxima es 255.

      • Tipo de autenticación ldap string

        Parte del registro del Protocolo ligero de acceso a directorios (LDAP) que la base de datos utiliza para autenticar a este usuario de base de datos en el host LDAP.

        Los valores son NONE, GROUP o USER. El valor predeterminado es NONE.

      • Tipo de autenticación oidc string

        Etiqueta legible que indica si el nuevo usuario o grupo de la base de datos se autentica con la autenticación federada de OIDC. Para crear un usuario con autenticación federada, especifique el valor "USER" en este campo. Para crear un grupo con autenticación federada, especifique el valor "IDP_GROUP " en este campo.

        Los valores son NONE, IDP_GROUP o USER. El valor predeterminado es NONE.

      • papeles matriz[objeto]

        Lista que proporciona los emparejamientos de un rol con una base de datos aplicable.

        Gama de recursos disponibles para este usuario de base de datos.

        Ocultar atributos de roles Mostrar atributos de roles Objeto
        • nombreDeColección string

          Colección en la que se aplica este rol.

        • nombreDeBaseDeDatos string Requerido

          Base de datos a la que se le conceden privilegios de acceso al usuario.

        • nombreDeRol string Requerido

          Etiqueta legible que identifica un grupo de privilegios asignados a un usuario de la base de datos. Este valor puede ser un rol integrado o personalizado.

          Los valores son atlasAdmin, backup, clusterMonitor, dbAdmin, dbAdminAnyDatabase, enableSharding, read, readAnyDatabase, readWrite, readWriteAnyDatabase o <a custom role name>.

      • ámbitos matriz[objeto]

        Lista que contiene los clústeres, lagos de datos de MongoDB Atlas y espacios de trabajo de MongoDB Atlas Streams a los que este usuario de la base de datos puede acceder. Si se omite, MongoDB Cloud otorga al usuario de la base de datos acceso a todos los clústeres, lagos de datos de MongoDB Atlas y espacios de trabajo de MongoDB Atlas Streams del proyecto.

        Gama de recursos disponibles para este usuario de base de datos.

        Ocultar atributos de ámbitos Mostrar atributos de ámbitos Objeto
        • Nombre string Requerido

          Etiqueta legible por humanos que identifica el clúster o MongoDB Atlas Data Lake al que este usuario de base de datos puede acceder.

          El formato debe coincidir con el siguiente patrón: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

        • tipo string Requerido

          Categoría de recurso al que este usuario de base de datos puede acceder.

          Los valores son CLUSTER, DATA_LAKE o STREAM.

      • Nombre de usuario string Requerido

        Etiqueta legible que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:

        Método de autenticación Parámetro necesario Valor del parámetro Formato de nombre de usuario
        AWS IAM awsIAMType ROLE ARN
        AWS IAM awsIAMType USER ARN
        X.509 x509Type CUSTOMER RFC 2253 Nombre distinguido
        X.509 x509Type MANAGED RFC 2253 Nombre distinguido
        LDAP ldapAuthType USER RFC 2253 Nombre distinguido
        LDAP ldapAuthType GROUP RFC 2253 Nombre distinguido
        Fuerza laboral de OIDC oidcAuthType IDP_GROUP ID de IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre del grupo de IdP
        OIDC carga de trabajo oidcAuthType USER ID de IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre de usuario del IdP
        ¡FUERA! awsIAMType, x509Type, ldapAuthType, oidcAuthType NONE Cadena alfanumérica

        La longitud máxima es 1024.

      • x509Tipo string

        Método X.509 que MongoDB Cloud utiliza para autenticar al usuario de la base de datos.

        • Para X.509 gestionado por la aplicación, especifica MANAGED.
        • Para X.509 autogestionado, especifique CUSTOMER.

        Los usuarios creados con el método CUSTOMER requieren un Common Name (CN) en el parámetro nombre de usuario. Debes crear usuarios autenticados externamente en la base de datos $external.

        Los valores son NONE, CUSTOMER o MANAGED. El valor predeterminado es NONE.

    • recuento total integer(int32)

      Número total de documentos disponibles. MongoDB Cloud omite este valor si includeCount se establece en false. El número total es una estimación y puede no ser exacto.

      El valor mínimo es 0.

  • 401 aplicación/json

    No autorizado.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 403 aplicación/json

    Forbidden.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 404 aplicación/json

    No se encontró.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

  • 500 aplicación/json

    Error Interno del Servidor.

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • badRequestDetail Objeto

      Detalle de solicitud incorrecto.

      Ocultar el atributo badRequestDetail Mostrar el atributo badRequestDetail Objeto
      • campos matriz[objeto]

        Describe todas las violaciones en una solicitud de cliente.

        Ocultar atributos de campos Mostrar atributos de campos Objeto
        • Descripción string Requerido

          Una descripción de por qué el elemento de solicitud es incorrecto.

        • Campo string Requerido

          Una ruta que conduce a un campo en el cuerpo de la solicitud.

    • detalle string

      Describe las condiciones o razones específicas que causan cada tipo de error.

    • Error integer(int32) Requerido

      Código de estado HTTP devuelto con este error.

      Documentación externa
    • errorCode string Requerido

      Código de error de aplicación devuelto con este error.

    • Parámetros matriz[objeto]

      Parámetros utilizados para dar más información sobre el error.

    • razón string

      Se devolvió un mensaje de error de aplicación con este error.

OBTENER /api/atlas/v1.0/grupos/{groupId}/databaseUsers
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/databaseUsers' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "awsIAMType": "NONE",
      "databaseName": "admin",
      "deleteAfterDate": "2026-05-04T09:42:00Z",
      "description": "string",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "ldapAuthType": "NONE",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "oidcAuthType": "NONE",
      "roles": [
        {
          "collectionName": "string",
          "databaseName": "string",
          "roleName": "atlasAdmin"
        }
      ],
      "scopes": [
        {
          "name": "string",
          "type": "CLUSTER"
        }
      ],
      "username": "string",
      "x509Type": "NONE"
    }
  ],
  "totalCount": 42
}
Ejemplos de respuestas (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Ejemplos de respuestas (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Ejemplos de respuestas (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Ejemplos de respuestas (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}