/ /

Obtén usuarios múltiples en un solo proyecto

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que el ID del grupo. Para los grupos existentes, el ID del grupo permanece igual. Esta página utiliza el término grupo, más familiar, cuando se refiere a descripciones. El endpoint sigue siendo el declarado en el documento.

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/users

Request Parameters

Parámetros de ruta de solicitud

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

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción
flattenTeams	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 endpoint devuelve solo los usuarios que tienen asignados 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.
includeOrgUsers	booleano	Opcional	Indicador que indica si la lista devuelta debe incluir a los usuarios con acceso implícito al Proyecto a través del `Organization Owner` o `Organization Read Only` rol. Es posible que no hayas asignado un rol a los usuarios individuales en este proyecto. Si esta bandera está configurada en `false`, el endpoint devuelve solo los usuarios que tienen un rol asignado en el proyecto. Si esta bandera està establecida en `true`, el endpoint devuelve tanto a los usuarios a los que se les han asignado roles en el proyecto como a los usuarios que tienen acceso implícito al proyecto a través de su rol en la organización. El valor por defecto es `false`.

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

El documento de respuesta JSON incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	El arreglo incluye un objeto para cada elemento detallado en la sección del `results` documento incrustado.
`links`	arreglo	El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.
`totalCount`	Número	Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

`results` embeddedDocument

Cada resultado corresponde a un usuario.

Nombre	Tipo	Descripción
Dirección de correo electrónico	string	Dirección de correo electrónico asignada al usuario de MongoDB Atlas devuelto.
Nombre	string	Primer nombre asignado al usuario MongoDB Atlas devuelto.
ID	string	Identificador único asignado al usuario devuelto de MongoDB Atlas.
Apellidos	string	Apellido asignado al usuario devuelto de MongoDB Atlas.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
Roles	objeto arreglo	Roles asignados al usuario de MongoDB Atlas devuelto.
roles.groupId	string	Identificador único para el proyecto al que se asignó al usuario de MongoDB Atlas devuelto el rol proporcionado en `role.roleName`.
roles.orgId	string	Identificador único de la organización a la que se asignó al usuario de MongoDB Atlas el rol proporcionado en `role.roleName`.
roles.roleName	string	Nombre para mostrar para el rol asignado al usuario de MongoDB Atlas devuelto, ya sea 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 asignado al usuario de MongoDB Atlas devuelto.

Solicitud de ejemplo

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

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

Respuesta del cuerpo

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/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" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/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" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/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

Actualizar roles

Agregar usuarios existentes