Docs Home

/ /

Equipos

Docs Home

/ /

Organizaciones y equipos

Organizaciones y equipos

Equipos

Agregar usuarios al equipo

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

Este punto final es incompatible con proyectos que utilizan Autenticación LDAP.

URL base: https://{OPSMANAGER-HOST}:{PORT}/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 la organización con la que desea asociar el equipo.
`TEAM-ID`	Requerido	El nombre del equipo al que desea agregar usuarios.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonita

booleano

Opcional

Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.

false

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 envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	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	El ID único del usuario que desea 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	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 elemento de la matriz result es un usuario agregado al equipo.

Nombre	Tipo	Descripción
`country`	string	El código de país ISO 3166 Alpha-2 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 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.
`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 organización asignado al usuario para el `roles.orgId` especificado.
`teamsId`	arreglo	Cada cadena de la matriz es un equipo asociado con el usuario.
`username`	string	Nombre de usuario asociado al usuario.

Ejemplo de solicitud

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

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": "https://{OPSMANAGER-HOST}:{PORT}/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://{OPSMANAGER-HOST}:{PORT}/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

Nota

Sintaxis

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado