Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que el ID del grupo. Para los grupos existentes, el ID del grupo permanece igual. Esta página utiliza el término grupo, más familiar, cuando se refiere a descripciones. El endpoint sigue siendo el declarado 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.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
POST /users
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta debe estar en formato prettyprint. |
| ||||||
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, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
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:
|
Respuesta
El documento JSON contiene cada uno de los siguientes elementos:
Name | Tipo | Descripción | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Correo electrónico del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Primer nombre del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Identificador único del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Apellido del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| objeto arreglo | Enlaces hacia recursos secundarios relacionados. Todos los | ||||||||||||||||||||||||||||||
| string | Número de teléfono móvil del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| Arreglo vacío | Rol asignado al usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Identificador único para el Proyecto en el que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||
| string | Identificador único de la organización en la que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||
| string | Nombre del rol. El recurso Los valores aceptados son:
| ||||||||||||||||||||||||||||||
| string | Nombre de usuario del usuario del Cloud Manager. |
Solicitud de ejemplo
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \ 6 --data ' 7 { 8 "username": "jane.doe@mongodb.com", 9 "emailAddress": "jane.doe@mongodb.com", 10 "firstName": "Jane", 11 "lastName": "Doe", 12 "password": "M0ng0D8!:)", 13 "country" : "US", 14 "roles": [{ 15 "groupId": "533daa30879bb2da07807696", 16 "roleName": "GROUP_USER_ADMIN" 17 },{ 18 "orgId" : "55555bbe3bd5253aea2d9b16", 19 "roleName" : "ORG_MEMBER" 20 }] 21 }'
Respuesta de ejemplo
Encabezado de respuesta
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
201 Created Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Respuesta del cuerpo
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : [] }