/ /

Proyectos y usuarios

Usuarios

Docs Home

Gestión

Gerente de Operaciones

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, 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 /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 especifica si el cuerpo de la respuesta está en formato legible.	`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, ajusta 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`

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 mms.email.validation:

Valor	Descripción
`false`	(Por defecto) el nombre de usuario no necesita ser una dirección de correo electrónico.
`loose`	El nombre de usuario debe contener un símbolo `@` seguido de un punto.
`strict`	El nombre de usuario debe cumplir con una expresión regular de validación estricta de dirección de correo electrónico.

Consulta mms.email.validation para obtener más detalles.

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 GLOBAL_) no hay groupId ya que estos roles no están vinculados a un grupo.

roles.roleName

string

Nombre del rol. Los valores aceptados son:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

Respuesta

El documento JSON contiene cada uno de los siguientes elementos:

Name

Tipo

Descripción

emailAddress

string

Dirección de correo electrónico del usuario Ops Manager

firstName

string

Primer nombre del usuario de Ops Manager.

id

string

Identificador único del usuario de Ops Manager.

lastName

string

Apellido del usuario de Ops Manager.

links

objeto arreglo

Enlaces a subrecursos relacionados. Todos los arreglos links en las respuestas incluyen al menos un enlace llamado auto. La relación entre las URLs se explica en el Especificación de enlace web.

mobileNumber

string

Número de móvil del usuario de Ops Manager.

roles

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 groupId para los roles que empiezan con GLOBAL_. Estos roles no están vinculados a un proyecto.

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:

Valor	Descripción
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

username

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

HTTP/1.1 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

HTTP/1.1 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" : []
}

Volver

Obtener por nombre

Actualizar roles

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	}'