/ /

Organizaciones y equipos

Organizaciones y equipos

Equipos

Obtener todos los usuarios asignados a un equipo

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

Sintaxis

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users

Parámetros de ruta de solicitud

Elemento de ruta	Obligatorio/Opcional	Descripción
`ORG-ID`	Requerido	El identificador único de la organización asociada con el equipo.
`TEAM-ID`	Requerido	El identificador único del equipo cuya membresía de usuario desea recuperar.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint.	`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 o al código de estado. Para remediarlo, establezca `envelope : true` en la query. Para los endpoints que devuelven una lista de resultados, el objeto `content` es un sobre. Cloud Manager añade el campo `status` al cuerpo de la respuesta.	`false`
backupJobsEnabledOnly	booleano	Opcional	Indicador que indica si se deben excluir los demonios que no están habilitados para hacer copias de seguridad de bases de datos de la respuesta. Establece esto en `false` para incluir las configuraciones del demonio con la bandera `backupJobsEnabled` establecida en `false`.	`true`

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 elemento en el arreglo result es un usuario asignado al equipo.

Nombre	Tipo	Descripción
`emailAddress`	string	La dirección de correo electrónico asociada al usuario.
`firstName`	string	El nombre del usuario.
`id`	string	El identificador único del equipo.
`lastName`	string	El apellido del usuario.
`links`	objeto arreglo	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.
`roles`	arreglo	Cada objeto en la matriz `roles` representa el rol de la organización MongoDB Atlas que el usuario tiene para el `orgId` o `groupId` asociados.
`roles.orgId`	string	ID de la organización donde el usuario tiene asignado el `roles.roleName` rol en la organización.
`roles.groupId`	string	ID del proyecto donde el usuario tiene asignado el `roles.roleName` rol en el proyecto.
`roles.roleName`	string	El rol de organización asignado al usuario para el `roles.orgId` o `roles.groupId` especificado.
`teamsIds`	arreglo	Arreglo de identificadores de string para cada equipo del que el usuario es nodo.
`username`	string	Nombre de usuario asociado al usuario.

Solicitud de ejemplo

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"

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

Volver

Obtener uno por nombre

Crear