/ /

Equipos

Docs Home

/ /

Organizaciones y equipos

Organizaciones y equipos

Equipos

Agregar usuarios al equipo

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

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

Sintaxis

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

Parámetros de la ruta de solicitud

Elemento de ruta	Obligatorio/Opcional	Descripción
`ORG-ID`	Requerido.	El identificador único de organización con la que deseas asociar el equipo.
`TEAM-ID`	Requerido	El nombre del equipo al que deseas agregar usuarios.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de respuesta debe estar en un prettyprint formato.

false

envelope

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 endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:

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

false

Parámetros del cuerpo de la solicitud

Especifique una matriz de documentos, donde cada documento represente a un usuario que desea agregar al equipo. Cada documento de la matriz debe contener los siguientes campos:

Nombre	Tipo	Descripción
`id`	string	La ID única del usuario que deseas agregar al equipo

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
`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 de la matriz result es un usuario agregado al equipo.

Nombre	Tipo	Descripción
`country`	string	El ISO 3166 Alfa-2 código de país asociado con el usuario.
`emailAddress`	string	La dirección de correo electrónico asociada con el usuario.
`firstName`	string	El nombre del usuario.
`id`	string	El identificador único del equipo.
`lastName`	string	El apellido del usuario.
`links`	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.
`mobileNumber`	string	El número de teléfono asociado con el usuario.
`roles`	arreglo	Cada objeto en el arreglo `roles` representa el rol de organización de MongoDB Atlas que el usuario tiene para el `org_id`asociado
`roles.orgId`	string	ID de la organización donde el usuario tiene asignado el `roles.roleName` rol de organización.
`roles.roleName`	string	El rol de la organización asignado al usuario para el `roles.orgId` especificado.
`teamsId`	arreglo	Cada string en el arreglo es un equipo asociado con el usuario.
`username`	string	Nombre de usuario asociado al usuario.

Solicitud de ejemplo

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users? pretty=true" \
     --data '[{ "id" : "{USER-ID}" }]'

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?pretty=true",
      "rel": "self"
     }
 ],
 "results": [
     {
      "country": "US",
      "emailAddress": "JohnDoe@example.com",
      "firstName": "John",
      "id": "{USER-ID}",
      "lastName": "Doe",
      "links": [
          {
              "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
              "rel": "self"
          }
      ],
      "mobileNumber": "5555550100",
      "roles": [
          {
              "orgId": "{ORG-ID}",
              "roleName": "ORG_MEMBER"
          },
          ...
      ],
      "teamIds": [ "{TEAM-ID}" ],
      "username": "JohnDoe@example.com"
     }
 ],
 "totalCount": 1
}

Volver

Actualizar roles

Remover usuario

Sintaxis

Parámetros de la ruta de solicitud

Parámetros de Solicitud Query

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results embeddedDocument

Solicitud de ejemplo

Respuesta de ejemplo

Encabezado de respuesta

Respuesta del cuerpo

`results` embeddedDocument