Obtener todos los usuarios en un proyecto

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

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.

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

Resource

GET /groups/{PROJECT-ID}/users

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Necesidad	Descripción
PROJECT-ID	string	Requerido	Identificador único del proyecto.

Parámetros de consulta de solicitud

Nombre	Tipo	Necesidad	Descripción
aplanar equipos	booleano	Opcional	Bandera que indica si la lista devuelta debe incluir usuarios que pertenecen a un equipo asignado a un rol en este proyecto. Es posible que no haya asignado a los usuarios individuales un rol en este proyecto. Si esta bandera se establece en `false`, el punto final devuelve solo los usuarios a los que se les asignó un rol en el proyecto. Si este indicador está establecido en `true`, el endpoint devolverá tanto los usuarios a los que se les asignaron roles en el proyecto y los usuarios que son miembros de equipos a los que se les asignaron roles en el proyecto.
incluirOrgUsers	booleano	Opcional	Bandera que indica si la lista devuelta debe incluir usuarios con acceso implícito al proyecto a través de `Organization Owner` `Organization Read Only` Rol o. Es posible que no haya asignado un rol a los usuarios individuales en este proyecto. Si esta bandera se establece en `false`, el punto final devuelve solo los usuarios a quienes se les asigna un rol en el proyecto. Si esta bandera se establece `true` en, el punto final devuelve tanto los usuarios que tienen roles asignados en el proyecto como los usuarios que tienen acceso implícito al proyecto a través de su rol de organización. El valor por defecto es `false`.

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

La respuesta El documentoJSON incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en la `results` sección Documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es un usuario.

Nombre	Tipo	Descripción
dirección de correo electrónico	string	Dirección de correo electrónico asignada al usuario MongoDB Atlas devuelto.
firstName	string	Primer nombre asignado al usuario MongoDB Atlas devuelto.
ID.	string	Identificador único asignado al usuario MongoDB Atlas devuelto.
lastName	string	Apellido asignado al usuario MongoDB Atlas devuelto.
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.
papeles	matriz de objetos	Roles asignados al usuario de MongoDB Atlas devuelto.
roles.groupId	string	Identificador único del proyecto al que se le asignó el rol proporcionado en `role.roleName` al usuario MongoDB Atlas devuelto.
roles.orgId	string	Identificador único de la organización a la que se le asignó el rol proporcionado en `role.roleName` al usuario MongoDB Atlas devuelto.
roles.nombreDeRol	string	Nombre para mostrar del rol asignado al usuario MongoDB Atlas devuelto para el grupo proporcionado en `role.groupId` o la organización proporcionada en `role.orgId`.
Nombre de usuario	string	Nombre de usuario de MongoDB Atlas proporcionado al usuario de MongoDB Atlas devuelto.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=true"

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"
    }, {
      "orgId" : "{ORGANIZATION-ID}",
      "roleName" : "ORG_READ_ONLY"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}

Volver

Borrar

Agregar usuarios existentes