Nota
Este endpoint es incompatible con los 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 ruta de solicitud
Elemento de ruta | Obligatorio/Opcional | Descripción |
|---|---|---|
| Requerido. | El identificador único de la organización con la que quieres asociar el equipo. |
| 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 la respuesta debe estar en un pretty-print formato. |
| ||||||
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos Los clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar este problema, configure envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye:
|
|
Parámetros del cuerpo de la solicitud
Especifique un arreglo de documentos, donde cada documento represente a un usuario que desee agregar al equipo. Cada documento en el arreglo debe contener los siguientes campos:
Nombre | Tipo | Descripción |
|---|---|---|
| string | La ID única del usuario que deseas agregar al equipo |
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de result objetos, un arreglo de link objetos y una cantidad del número total de result objetos recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| 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. |
| 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 del arreglo result es un usuario añadido al equipo.
Nombre | Tipo | Descripción |
|---|---|---|
| string | El ISO 3166 Alfa-2 código de país asociado con el usuario. |
| string | La dirección de correo electrónico asociada con el usuario. |
| string | El nombre del usuario. |
| string | El identificador único del equipo. |
| string | El apellido del usuario. |
| arreglo | Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los |
| string | El número de teléfono asociado con el usuario. |
| arreglo | Cada objeto en el arreglo |
| string | ID de la organización donde el usuario tiene asignado el |
| string | El rol de la organización asignado al usuario para el |
| arreglo | Cada string en el arreglo es un equipo asociado con el usuario. |
| 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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true" \ --data '[{ "id" : "{USER-ID}" }]'
Respuesta de ejemplo
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}
Respuesta del cuerpo
{ "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 }