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://cloud.mongodb.com/api/public/v1.0
Sintaxis
GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users
Parámetros de la ruta de solicitud
Elemento de ruta | Obligatorio/Opcional | Descripción |
|---|---|---|
| Requerido | El identificador único para el organización asociada al equipo. |
| Requerido | El identificador único del equipo cuya membresía de usuario desea recuperar. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
número de página | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
artículos por página | Número | Opcional | Número de artículos a devolver por página, hasta un máximo de 500. |
|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
|
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 Para los endpoints que devuelven una lista de resultados, el objeto |
|
trabajos de respaldo habilitados solamente | booleano | Opcional | Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en |
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Documento de respuesta
El documento JSON de respuesta 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 |
|---|---|---|
| arreglo | La matriz incluye un objeto para cada elemento detallado en la |
| 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. |
| 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 elemento de la matriz result es un usuario asignado al equipo.
Nombre | Tipo | Descripción |
|---|---|---|
| string | La dirección de correo electrónico asociada al usuario. |
| string | El nombre del usuario. |
| string | El identificador único del equipo. |
| string | El apellido del usuario. |
| matriz de objetos | Uno o más enlaces a sub-recursos y/o recursos relacionados. Los tipos de relación entre URLs se explican en la Especificación de Vinculación Web. |
| arreglo | Cada objeto de la |
| string | ID de la organización donde el usuario tiene asignado el |
| string | ID del proyecto donde el usuario tiene asignado el |
| string | El rol de organización asignado al usuario para el |
| arreglo | Matriz de identificadores de cadena para cada equipo del que es miembro el usuario. |
| string | Nombre de usuario asociado al usuario. |
Ejemplo de solicitud
curl --user "{username:apiKey}" --digest -i \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request GET "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true"
Ejemplo de respuesta
Encabezado de respuesta
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
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": "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "emailAddress": "CloudUser@example.com", "firstName": "Cloud", "id": "{USER-ID}", "lastName": "User", "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}", "rel": "self" } ], "roles": [ { "groupId": "{PROJECT-ID}", "roleName": "GROUP_OWNER" }, { "orgId": "{ORG-ID}", "roleName": "ORG_OWNER" } ], "teamIds": [ "{TEAM-ID}" ], "username": "CloudUser@example.com" } ], "totalCount": 1 }