Devolver un usuario de MongoDB Cloud por nombre de usuario

OBTENER /api/atlas/v1.0/users/byName/{userName}

Devuelve los detalles de una cuenta de usuario de MongoDB Cloud con el nombre de usuario especificado. No se puede usar este endpoint para devolver información sobre una Clave de API. Para devolver información sobre una clave API, utilice el endpoint Return One Organization de clave API.

Parámetros de path

  • Nombre de usuario string Requerido

    Dirección de correo electrónico que pertenece a la cuenta de usuario de MongoDB nube. No puedes modificar esta dirección después de crear el usuario.

    El formato debe coincidir con el siguiente patrón: ^[a-z0-9!#$%&'*+/=?^_{|}~-]+(?:.[a-z0-9!#$%&'+/=?_`{|}~-]+)@(?:a-z0-9?.)+a-z0-9?$`.

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.

    pretty-print

Respuestas

  • 200 application/json

    OK

    Ocultar atributos de respuesta Mostrar los atributos de respuesta Objeto
    • País string Requerido

      Dos caracteres del alfabeto que identifican la ubicación geográfica del usuario de MongoDB Cloud. Este parámetro utiliza el formato de código ISO 3166-1a2.

      El formato debe coincidir con el siguiente patrón: ^([A-Z]{2})$.

    • creado a las string(date-time)

      Fecha y hora de creación de la cuenta actual. Este valor está en el formato de marca de tiempo ISO 8601 en UTC.

    • Dirección de correo electrónico string(email) Requerido Obsoleto

      Dirección de correo electrónico que pertenece al usuario de MongoDB nube.

    • Nombre string Requerido

      Primer o segundo nombre que pertenece al usuario de la nube de MongoDB.

    • ID string

      string única de 24 dígitos hexadecimales que identifica al usuario de MongoDB nube.

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

    • última autenticación string(date-time)

      Fecha y hora en que la cuenta actual se autenticó por última vez. Este valor está en el formato de marca de tiempo ISO 8601 en UTC.

    • Apellidos string Requerido

      Apellido familiar, nombre de familia o apellido que pertenece al usuario de MongoDB Cloud.

    • Número de teléfono móvil string Requerido

      Número de teléfono móvil que pertenece al usuario de MongoDB nube.

      El formato debe coincidir con el siguiente patrón: (?:(?:\\+?1\\s*(?:[.-]\\s*)?)?(?:(\\s*([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\\s*)|([2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\\s*(?:[.-]\\s*)?)([2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\\s*(?:[.-]\\s*)?([0-9]{4})$.

    • Contraseña string(password) Requerido

      Contraseña aplicada al nombre de usuario para iniciar sesión en MongoDB nube. MongoDB Cloud no devuelve este parámetro excepto en respuesta a la creación de un nuevo usuario de MongoDB Cloud. Solo el usuario de MongoDB Cloud puede actualizar su contraseña después de que se haya establecido desde la consola de MongoDB Cloud.

      La longitud mínima es 8.

    • Roles arreglo[objeto] Requerido

      Lista de objetos que muestran los roles del usuario de MongoDB Cloud y la organización o proyecto correspondiente al que se aplica ese rol. Un rol puede aplicarse a una organización o un proyecto, pero no a ambos.

      Hide roles attributes Mostrar atributos de roles Objeto

      Los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondiente al que se aplica ese rol. Cada rol puede aplicarse a una organización o un proyecto, pero no a ambos.

      Roles de claves en la API de MongoDB nube
      • ID del grupo string

        string de dígitos hexadecimales 24-única que identifica el Proyecto al que pertenece este rol. Puedes establecer un valor para este parámetro o orgId, pero no ambos en la misma solicitud.

        La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • orgId string

        string única de 24dígitos hexadecimales que identifica la organización a la que pertenece este rol. Puede establecer un valor para este parámetro o groupId, pero no ambos en la misma solicitud.

        La longitud mínima es 24 y la máxima es 24. El formato debe coincidir con el siguiente patrón: ^([a-f0-9]{24})$.

      • nombreDelRol string

        Etiqueta legible por humanos que identifica la colección de privilegios que MongoDB Cloud otorga a una clave API específica, a un usuario de MongoDB Cloud o a un equipo de MongoDB Cloud. Estos roles incluyen roles a nivel de organización y de proyecto.

        Roles de usuario de MongoDB Cloud
    • teamIds array[string]

      Lista de cadenas únicas de 24dígitos hexadecimales que identifica los equipos a los que pertenece este usuario de MongoDB Cloud.

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

    • Nombre de usuario string(email) Requerido

      Dirección de correo electrónico que representa el nombre de usuario del usuario de MongoDB nube.

  • 401 application/json

    No autorizado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Forbidden.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    No se ha encontrado.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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 application/json

    Error interno del servidor.

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

      Detalle de solicitud incorrecta.

      Ocultad 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

      El código de error de la aplicación se devuelve 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/users/byName/{userName}
curl \
 --request GET 'https://cloud.mongodb.com/api/atlas/v1.0/users/byName/{userName}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Ejemplos de respuesta (200)
{
  "country": "string",
  "createdAt": "2026-05-04T09:42:00Z",
  "emailAddress": "hello@example.com",
  "firstName": "string",
  "id": "32b6e34b3d91647abb20e7b8",
  "lastAuth": "2026-05-04T09:42:00Z",
  "lastName": "string",
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "string"
    }
  ],
  "teamIds": [
    "32b6e34b3d91647abb20e7b8"
  ],
  "username": "hello@example.com"
}
Ejemplos de respuesta (401)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 401,
  "errorCode": "NOT_ORG_GROUP_CREATOR",
  "reason": "Unauthorized"
}
Ejemplos de respuesta (403)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 403,
  "errorCode": "CANNOT_CHANGE_GROUP_NAME",
  "reason": "Forbidden"
}
Ejemplos de respuesta (404)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "error": 404,
  "errorCode": "RESOURCE_NOT_FOUND",
  "reason": "Not Found"
}
Ejemplos de respuesta (500)
{
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "error": 500,
  "errorCode": "UNEXPECTED_ERROR",
  "reason": "Internal Server Error"
}