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 grupo/proyecto permanece igual. Esta página utiliza el término más familiar «grupo» al referirse a 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 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /users
Parámetros de la 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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato. |
| ||||||
envelope | 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 endpoints 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 usuario de Ops Manager. Validado dependiendo del valor de
Consulta | ||||||||||||||||||||||||||||||||||||||||
Contraseña | string | Contraseña del usuario de Ops 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 | Dirección de correo electrónico del usuario Ops Manager | ||||||||||||||||||||||||||||||||||||||||
Número de teléfono móvil | string | Número de teléfono móvil del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
firstName | string | Primer nombre del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
lastName | string | Apellido del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
Roles | objeto arreglo | Asignaciones de roles del usuario Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único de la organización en la que el usuario de Ops Manager tiene el rol especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único del grupo en el que el usuario de Ops Manager tiene el rol especificado. Para los roles "globales" (aquellos cuyo nombre empieza por | ||||||||||||||||||||||||||||||||||||||||
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 Ops Manager | ||||||||||||||||||||||||||||||||||||||||
| string | Primer nombre del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Identificador único del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| string | Apellido del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| objeto arreglo | Enlaces a subrecursos relacionados. Todas las | ||||||||||||||||||||||||||||||||||||||||
| string | Número de móvil del usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
| Arreglo vacío | Rol asignado al usuario de Ops Manager. | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | string | Identificador único para el Proyecto en el que el usuario tiene el rol especificado. No se requiere un | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | string | Identificador único de la organización en la que el usuario tiene el rol especificado. | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | string | Nombre del rol. Los valores aceptados son:
| ||||||||||||||||||||||||||||||||||||||||
| string | Nombre de usuario del usuario de Ops 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://<OpsManagerHost>:<Port>/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 "roles": [{ 14 "groupId": "533daa30879bb2da07807696", 15 "roleName": "GROUP_USER_ADMIN" 16 },{ 17 "orgId" : "55555bbe3bd5253aea2d9b16", 18 "roleName" : "ORG_MEMBER" 19 }] 20 }'
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" : [] }