Nota
Grupos y proyectos son términos sinónimos. Su {PROJECT-ID} es el mismo que su ID del grupo. Para los grupos existentes, el ID del grupo se mantiene igual. Esta página utiliza el término más familiar grupo cuando se refiere a descripciones. El endpoint permanece tal 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 /usersPará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 está en formato pretty-print. |
|
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 Ops Manager. Validado dependiendo del valor de la propiedad
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. |
Nombre | string | Primer nombre del usuario de Ops Manager. |
Apellidos | 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.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 | 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 hacia recursos secundarios relacionados. Todos los |
| string | Número de móvil del usuario de Ops Manager. |
| Arreglo vacÃo | Rol asignado al usuario de Ops Manager. |
| string | Identificador único para el Proyecto en el que el usuario tiene el rol especificado. No se requiere un |
| string | Identificador único de la organización en la que el usuario tiene el rol especificado. |
| string | Nombre del rol. Los valores aceptados son:
|
| string | Nombre de usuario del usuario de Ops Manager. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/users" \ --data ' { "username": "jane.doe@mongodb.com", "emailAddress": "jane.doe@mongodb.com", "firstName": "Jane", "lastName": "Doe", "password": "M0ng0D8!:)", "roles": [{ "groupId": "533daa30879bb2da07807696", "roleName": "GROUP_USER_ADMIN" },{ "orgId" : "55555bbe3bd5253aea2d9b16", "roleName" : "ORG_MEMBER" }] }'Respuesta de ejemplo
Encabezado de respuesta
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-aliveHTTP/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}Respuesta del cuerpo
{ "id" : "533dc19ce4b00835ff81e2eb", "username" : "jane.doe@mongodb.com", "emailAddress" : "jane.doe@mongodb.com", "firstName" : "Jane", "lastName" : "Doe", "roles" : [], "links" : []}