Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.

Crea un usuario

Nota

Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, su ID del grupo sigue siendo el mismo. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El punto final permanece como se indica en el documento.

Crear un nuevo usuario. De forma predeterminada, cualquier rol de organización no global y de proyecto en la carga útil envía a los usuarios una invitación primero a la organización o al proyecto.

URL base: https://cloud.mongodb.com/api/public/v1.0

POST /users

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Los siguientes parámetros de query son opcionales:

Nombre
Tipo
Necesidad
Descripción
predeterminado

bonito

booleano

Opcional

Indicador que muestra si se debe devolver el cuerpo de la respuesta en un prettyprint formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, establezca envelope=true en la query.

Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

  • status: Código de respuesta HTTP

  • content: Cuerpo de respuesta esperado

false

Todos los campos son obligatorios.

Nombre
Tipo
Descripción

Nombre de usuario

string

Nombre de usuario del usuario de Cloud Manager. Debe ser una dirección de correo electrónico válida.

Contraseña

string

Contraseña del usuario de Cloud Manager.

Este campo no está incluido en la entidad devuelta por el servidor. Solo se puede enviar en el cuerpo de la entidad cuando se crea un nuevo usuario.

Dirección de correo electrónico

string

Correo electrónico del usuario de Cloud Manager.

Número de teléfono móvil

string

Número de teléfono móvil del usuario del Cloud Manager.

Nombre

string

Primer nombre del usuario de Cloud Manager.

Apellidos

string

Apellido del usuario de Cloud Manager.

País

string

País principal donde se encuentra el usuario de Cloud Manager. Debe coincidir con un código de país de dos letras ISO 3661-1.

Roles

objeto arreglo

Asignaciones de rol del usuario del Cloud Manager.

roles.orgId

string

Identificador único de la organización en la que el usuario de Cloud Manager tiene el rol especificado.

roles.groupId

string

Identificador único del grupo en el que el usuario del Cloud Manager tiene el rol especificado.

roles.roleName

string

Nombre del rol. Los valores aceptados son:

El documento JSON contiene cada uno de los siguientes elementos:

Name
Tipo
Descripción

emailAddress

string

Correo electrónico del usuario de Cloud Manager.

firstName

string

Primer nombre del usuario de Cloud Manager.

id

string

Identificador único del usuario de Cloud Manager.

lastName

string

Apellido del usuario de Cloud Manager.

links

objeto arreglo

Enlaces a subrecursos relacionados. Todos los arreglos links en las respuestas incluyen al menos un enlace llamado self. La Especificación de vinculación web explica estas relaciones de vinculación.

mobileNumber

string

Número de teléfono móvil del usuario de Cloud Manager.

roles

Arreglo vacío

Rol asignado al usuario de Cloud Manager.

roles
.groupId

string

Identificador único para el proyecto donde el usuario tiene el rol especificado.

roles
.orgId

string

Identificador único de la organización donde el usuario tiene el rol especificado.

roles
.roleName

string

Nombre del rol. El recurso users devuelve todos los roles que tiene el usuario en Cloud Manager y MongoDB Atlas.

Los valores aceptados son:

username

string

Nombre de usuario del usuario del Cloud Manager.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \ --data ' { "username": "jane.doe@mongodb.com", "emailAddress": "jane.doe@mongodb.com", "firstName": "Jane", "lastName": "Doe", "password": "M0ng0D8!:)", "country" : "US", "roles": [{ "groupId": "533daa30879bb2da07807696", "roleName": "GROUP_USER_ADMIN" },{ "orgId" : "55555bbe3bd5253aea2d9b16", "roleName" : "ORG_MEMBER" }] }'
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : []}