Nota
Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.
Crear un nuevo usuario. De forma predeterminada, cualquier rol de organización o proyecto no global en la carga útil envía primero a los usuarios una invitación a la organización o al proyecto.
Resource
URL base: https://cloud.mongodb.com/api/public/v1.0
POST /users
Parámetros de la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
envolvente | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Los campos son obligatorios.
Nombre | Tipo | Descripción | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Nombre de usuario | string | Nombre de usuario del administrador de la nube. Debe ser una dirección de correo electrónico válida. | ||||||||||||||||||||||||||||||||
contraseña | string | Contraseña del usuario de Cloud Manager. Este campo no se incluye en la entidad devuelta por el servidor. Solo se puede enviar en el cuerpo de la entidad al crear un nuevo usuario. | ||||||||||||||||||||||||||||||||
dirección de correo electrónico | string | Dirección de 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 de Cloud Manager. | ||||||||||||||||||||||||||||||||
firstName | string | Nombre del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||||
lastName | string | Apellido del usuario Cloud Manager. | ||||||||||||||||||||||||||||||||
país | string | País principal donde reside el usuario de Cloud Manager. Debe coincidir con un código de país ISO 3661de dos letras -.1 | ||||||||||||||||||||||||||||||||
papeles | matriz de objetos | Asignaciones de roles del usuario Cloud Manager. | ||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único de la organización en la que el usuario Cloud Manager tiene el rol especificado. | ||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único del grupo en el que el usuario Cloud Manager tiene el rol especificado. | ||||||||||||||||||||||||||||||||
roles.nombreDeRol | string | Nombre del rol. Los valores aceptados son:
|
Respuesta
El documento JSON contiene cada uno de los siguientes elementos:
Name | Tipo | Descripción | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| string | Dirección de correo electrónico del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Nombre del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Identificador único del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| string | Apellido del usuario Cloud Manager. | ||||||||||||||||||||||||||||||
| matriz de objetos | Enlaces a subrecursos relacionados. Todas las | ||||||||||||||||||||||||||||||
| string | Número de móvil del usuario de Cloud Manager. | ||||||||||||||||||||||||||||||
| matriz vacía | Rol asignado al usuario Cloud Manager. | ||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único del proyecto en el que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único de la organización en la que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||
roles.roleName | string | Nombre del rol. El recurso Los valores aceptados son:
| ||||||||||||||||||||||||||||||
| string | Nombre de usuario del usuario Cloud Manager. |
Ejemplo de solicitud
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 }'
Ejemplo de respuesta
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}
Cuerpo de respuesta
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : [] }