Crear un usuario de MongoDB Cloud Obsoleto

PUBLICAR /api/atlas/v2/usuarios

Crea una cuenta de usuario de MongoDB Cloud. Una cuenta de usuario de MongoDB Cloud otorga acceso únicamente a la aplicación MongoDB Cloud. Para otorgar acceso a la base de datos, cree un usuario de base de datos. MongoDB Cloud envía un correo electrónico a los usuarios que especifique, invitándolos a unirse al proyecto. Los usuarios invitados no tienen acceso al proyecto hasta que aceptan la invitación. Las invitaciones caducan después de 30 días.

MongoDB Cloud limita la membresía de usuario de MongoDB nube a un máximo de 250 usuarios de MongoDB nube por equipo. MongoDB nube limita la membresía de usuario de MongoDB nube a 500 usuarios de MongoDB nube por Proyecto y 500 usuarios de MongoDB nube por organización, lo que incluye la membresía combinada de todos los Proyectos en la organización. MongoDB nube genera un error si una operación supera estos límites. Por ejemplo, si tienes una organización con cinco Proyectos, y cada Proyecto tiene 100 usuarios de MongoDB nube, y cada usuario de MongoDB nube pertenece solo a un Proyecto, no puedes agregar ningún usuario de MongoDB nube a esta organización sin antes remover los usuarios existentes de MongoDB nube de la organización.

Para utilizar este recurso, la cuenta de servicio o la clave API solicitante puede tener cualquier rol.

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.

  • bonita booleano

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

    El valor predeterminado es false.

    Impresión bonita
application/vnd.atlas.2023-01-01+json

Cuerpo Requerido

Cuenta de usuario de MongoDB Cloud para crear.

  • país string Requerido

    Dos caracteres alfabéticos 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})$.

  • firstName string Requerido

    Nombre o nombre de pila que pertenece al usuario de MongoDB Cloud.

  • lastName string Requerido

    Apellido, 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 Cloud.

    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 cadena(contraseña) Requerido

    Contraseña aplicada con el nombre de usuario para iniciar sesión en MongoDB Cloud. MongoDB Cloud no devuelve este parámetro, excepto al crear un nuevo usuario. Solo el usuario de MongoDB Cloud puede actualizar su contraseña después de configurarla desde la consola.

    La longitud mínima es 8.

  • papeles matriz[objeto]

    Lista de objetos que muestran los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondientes a los que corresponde dicho rol. Un rol puede aplicarse a una organización o a un proyecto, pero no a ambos.

    Roles de usuario de MongoDB Cloud y la organización o proyecto correspondiente al que corresponde cada rol. Cada rol puede aplicarse a una organización o a un proyecto, pero no a ambos.

    Ocultar atributos de roles Mostrar atributos de roles Objeto
    • ID de grupo string

      Cadena única de dígitos hexadecimales 24que identifica el proyecto al que pertenece este rol. Puede 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

      Cadena única de dígitos hexadecimales 24que 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})$.

    • nombreDeRol string

      Etiqueta legible que identifica el conjunto de privilegios que MongoDB Cloud otorga a una clave de API, un usuario o un equipo de MongoDB Cloud específicos. Estos roles incluyen roles a nivel de organización y de proyecto.

      Roles de usuario de MongoDB Cloud
  • Nombre de usuario cadena(correo electrónico) Requerido

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

Respuestas

  • 200 application/vnd.atlas.2023-01-01+json

    Vale

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

      Dos caracteres alfabéticos 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})$.

    • creadoEn cadena(fecha-hora)

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

    • dirección de correo electrónico cadena(correo electrónico) Requerido Obsoleto

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

    • firstName string Requerido

      Nombre o nombre de pila que pertenece al usuario de MongoDB Cloud.

    • ID. string

      Cadena de dígitos hexadecimales 24única que identifica al usuario de MongoDB Cloud.

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

    • última autorización cadena(fecha-hora)

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

    • lastName string Requerido

      Apellido, 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 Cloud.

      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 cadena(contraseña) Requerido

      Contraseña aplicada con el nombre de usuario para iniciar sesión en MongoDB Cloud. MongoDB Cloud no devuelve este parámetro, excepto al crear un nuevo usuario. Solo el usuario de MongoDB Cloud puede actualizar su contraseña después de configurarla desde la consola.

      La longitud mínima es 8.

    • papeles matriz[objeto]

      Lista de objetos que muestran los roles del usuario de MongoDB Cloud y la organización o el proyecto correspondientes a los que corresponde dicho rol. Un rol puede aplicarse a una organización o a un proyecto, pero no a ambos.

      Roles de usuario de MongoDB Cloud y la organización o proyecto correspondiente al que corresponde cada rol. Cada rol puede aplicarse a una organización o a un proyecto, pero no a ambos.

      Ocultar atributos de roles Mostrar atributos de roles Objeto
      • ID de grupo string

        Cadena única de dígitos hexadecimales 24que identifica el proyecto al que pertenece este rol. Puede 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

        Cadena única de dígitos hexadecimales 24que 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})$.

      • nombreDeRol string

        Etiqueta legible que identifica el conjunto de privilegios que MongoDB Cloud otorga a una clave de API, un usuario o un equipo de MongoDB Cloud específicos. Estos roles incluyen roles a nivel de organización y de proyecto.

        Roles de usuario de MongoDB Cloud
    • ID de equipo array[string]

      Lista de cadenas de dígitos hexadecimales 24únicos que identifican 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 cadena(correo electrónico) Requerido

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

  • 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.

POST /api/atlas/v2/usuarios
atlas api mongoDbCloudUsers createUser --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.CreateUserApiParams{}
	sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
		CreateUserWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  --header "Content-Type: application/json" \
  -X POST "https://cloud.mongodb.com/api/atlas/v2/users" \
  -d '{ <Payload> }'
Solicitar ejemplos
{
  "country": "string",
  "firstName": "string",
  "lastName": "string",
  "mobileNumber": "string",
  "password": "string",
  "roles": [
    {
      "groupId": "32b6e34b3d91647abb20e7b8",
      "orgId": "32b6e34b3d91647abb20e7b8",
      "roleName": "string"
    }
  ],
  "username": "hello@example.com"
}
Ejemplos de respuestas (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 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"
}