/ /

Gerente de Operaciones

Agregar usuarios existentes a un proyecto

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.

Este recurso agrega usuarios existentes en Ops Manager a otro proyecto. No crea nuevos usuarios ni los agrega a un proyecto. De forma predeterminada, los usuarios reciben primero una invitación al proyecto. Solo puede agregar usuarios directamente a un proyecto si configura la opción mms.user.bypassInviteForExistingUsers estableciendo true en.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

POST /groups/{PROJECT-ID}/users

Request Parameters

Parámetros de la ruta de solicitud

Parameter	Tipo	Descripción
PROJECT-ID	string	(Obligatorio) El identificador único del proyecto.

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 un impresión bonita formato.

false

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:

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
ID.	string	El identificador único de un usuario existente.
papeles	matriz de objetos	Los roles a los que se asigna este usuario.
roles.groupId	string	El identificador único para el rol del proyecto.
roles.nombreDeRol	string	El nombre para mostrar del rol de usuario.

Respuesta

Nombre	Tipo	Descripción
dirección de correo electrónico	string	La dirección de correo electrónico del usuario Ops Manager.
firstName	string	El primer nombre que se muestra para el usuario retornado de Ops Manager.
ID.	string	El identificador único del usuario.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
lastName	string	El apellido que se muestra para el usuario de Ops Manager devuelto.
papeles	matriz de objetos	Los roles a los que se asigna este usuario.
roles.groupId	string	El identificador único para el rol del proyecto.
roles.nombreDeRol	string	El nombre para mostrar del rol de usuario.
Nombre de usuario	string	El nombre de usuario de Ops Manager.

Ejemplo de solicitud

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/groups/{PROJECT-ID}/users?pretty=true" \
 --data '
 [
   {
     "id": "{USER-ID}",
     "roles": [{
       "roleName": "GROUP_OWNER"
     }]
   }
 ]'

Nota

Debes enviar un arreglo de entidades, incluso si agregas un solo usuario. Para cada usuario que desees agregar, especifica la ID de usuario y los roles que debe poseer el usuario. Para los valores de rol, consulte la descripción del campo roles.roleName en el recurso de usuarios.

Si especifica un usuario que ya es miembro del proyecto, sus roles existentes se sobrescriben con los permisos especificados.

Ejemplo de respuesta

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 200 OK
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

{
  "links" : [ {
    "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "http://{opsManagerHost}:{port}/api/public/v1.0/users/{OTHER-USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}

Volver

Obtener todos los usuarios

Remover usuario