Devolver un usuario de base de datos de un proyecto

OBTENER /api/atlas/v1.0/groups/{groupId}/databaseUsers/{databaseName}/{username}

Devuelve uno de los usuarios de base de datos que pertenece al proyecto especificado. Para utilizar este recurso, la cuenta de servicio o la clave de API que realiza la solicitud debe tener el rol Solo lectura del proyecto.

Parámetros de path

  • ID del grupo string Requerido

    string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

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

  • nombreDeBaseDeDatos string Requerido

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

  • Nombre de usuario string Requerido

    etiqueta legible por humanos 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
    Plantilla de trabajo 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 proveedor de identidad de Atlas OIDC (encontrado en la configuración de federación), seguido de un '/', seguido del nombre de usuario de proveedor de identidad
    ¡FUERA! awsIAMType, x509Type, ldapAuthType, oidcAuthType NONE Cadena alfanumérica

Parámetros de query

  • envelope booleano

    Bandera que indica si la aplicación envuelve 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 remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.

    El valor por defecto es false.

  • bonito booleano

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

    El valor por defecto es false.

    Impresión bonita

Respuestas

  • 200 aplicación/json

    Vale

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • awsIAMType string

      Etiqueta legible por humanos que indica si el nuevo usuario de la base de datos se autentica con las credenciales de Amazon Web Services (AWS) de Identity and Access Gestión (IAM) asociadas al usuario o al rol del usuario.

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

    • nombreDeBaseDeDatos string Requerido

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

      Los valores son admin o $external. El valor por defecto es admin.

    • deleteAfterDate string(date-time)

      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 arreglo[objeto]

      Lista que contiene los pares clave-valor para etiquetar y categorizar al usuario de base de datos de MongoDB. Las etiquetas que definas no aparecerán en la consola.

      Ocultar los atributos de las etiquetas Mostrar atributos de las etiquetas Objeto

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

      • llave string

        Clave aplicada para etiquetar y categorizar este componente.

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

      • Valor string

        Valor establecido a la Llave aplicada para etiquetar y categorizar este componente.

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

    • ldapAuthType string

      Parte del registro del Protocolo Ligero de Acceso a Directorios (LDAP) que la base de datos utiliza para autenticar a este usuario de la base de datos en el host LDAP.

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

    • oidcAuthType string

      etiqueta legible por humanos que indica si el nuevo usuario de base de datos o grupo se autentica con autenticación federada OIDC. Para crear un usuario con autenticación federada, especifica el valor de USUARIO en este campo. Para crear un grupo de autenticación federada, especifica el valor de IDP_GROUP en este campo.

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

    • Roles arreglo[objeto] Requerido

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

      Hide roles attributes Mostrar atributos de roles Objeto

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

      • Nombre de colección string

        Colección en la que se aplica este rol.

      • nombreDeBaseDeDatos string Requerido

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

      • nombreDelRol string Requerido

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

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

    • alcances arreglo[objeto]

      Lista que contiene clústeres, MongoDB Atlas Data Lakes y MongoDB Atlas Streams Workspaces a los que este usuario de base de datos puede acceder. Si se omite, MongoDB Cloud concederá al usuario de base de datos acceso a todos los clústeres, MongoDB Atlas Data Lakes y MongoDB Atlas Streams Workspaces en el Proyecto.

      Ocultar atributos de ámbito Mostrar los atributos de alcance Objeto

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

      • 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 recursos a la que puede acceder este usuario de base de datos.

        Los valores son CLUSTER, DATA_LAKE o STREAM.

    • Nombre de usuario string Requerido

      etiqueta legible por humanos 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
      Plantilla de trabajo 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 proveedor de identidad de Atlas OIDC (encontrado en la configuración de federación), seguido de un '/', seguido del nombre de usuario de proveedor de identidad
      ¡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, especifica 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.

  • 401 aplicación/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

  • 403 aplicación/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve 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 incorrecta.

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

        Describe todas las infracciones en una solicitud de cliente.

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

          Una descripción de por qué el elemento de la 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 arreglo[objeto]

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

    • motivo string

      El mensaje de error de la aplicación se devuelve con este error.

GET /api/atlas/v1.0/grupos/{groupId}/nombre de usuario/{databaseName}/{username}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/databaseUsers/{databaseName}/SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuestas (200)
{
  "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"
}
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"
}