Obtenga una invitación al proyecto

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.

Recupere detalles de una invitación pendiente para el proyecto de Ops Manager especificado.

Roles necesarios

Puede llamar a este punto final con éxito con el Project User Admin role.

Resource

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{GROUP-ID}/invites/{INVITATION-ID}

Parámetros de la ruta de solicitud

Elemento de ruta	Tipo	Necesidad	Descripción
ID DE GRUPO	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica el proyecto.
ID DE INVITACIÓN	string	Requerido	Cadena de dígitos hexadecimales 24única que identifica la invitación.

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

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
creadoEn	string	Marca de tiempo en formato ISO 8601 de fecha y hora en UTC cuando Ops Manager envió la invitación.
expira en	string	Marca de tiempo en formato ISO 8601 fecha y hora en UTC cuando expira la invitación. Los usuarios tienen 30 días para aceptar una invitación a un proyecto de Ops Manager.
ID de grupo	string	Cadena de dígitos hexadecimales 24única que identifica el proyecto.
nombre del grupo	string	Nombre del proyecto.
ID.	string	Cadena de dígitos hexadecimales 24única que identifica la invitación.
inviterUsername	string	Usuario de Ops Manager que invitó a nombre de usuario al proyecto.
papeles	matriz de cadenas	Roles de administrador de operaciones para asignar al usuario invitado. Si el usuario acepta la invitación, Ops Manager le asigna estos roles.
Nombre de usuario	string	Dirección de correo electrónico a la que Ops Manager envió la invitación. Si el usuario acepta la invitación, utilizará esta dirección de correo electrónico como su nombre de usuario de Ops Manager.

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
     --header "Accept: application/json" \
     --request GET "https://opsmanager.example.com/api/public/v1.0/groups/{GROUP-ID}/invites/{INVITATIO-ID}?pretty=true"

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

1 {
2   "createdAt": "2021-02-18T18:51:46Z",
3   "expiresAt": "2021-03-20T18:51:46Z",
4   "groupId": "{GROUP-ID}",
5   "groupName": "group",
6   "id": "{INVITATION-ID}",
7   "inviterUsername": "admin@example.com",
8   "roles": [
9     "GROUP_OWNER"
10   ],
11   "username": "jane.smith@example.com"
12 }

Volver

Obtener todas las invitaciones

Actualizar invitación por ID de invitación

1	{
2	"createdAt": "2021-02-18T18:51:46Z",
3	"expiresAt": "2021-03-20T18:51:46Z",
4	"groupId": "{GROUP-ID}",
5	"groupName": "group",
6	"id": "{INVITATION-ID}",
7	"inviterUsername": "admin@example.com",
8	"roles": [
9	"GROUP_OWNER"
10	],
11	"username": "jane.smith@example.com"
12	}