/ /

/ /

Gerente de Operaciones

Consigue una invitación para un proyecto

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

Roles necesarios

Puede llamar exitosamente a este endpoint con la 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 del grupo	string	Requerido	string única de 24 dígitos hexadecimales que identifica el Proyecto.
ID DE INVITACIÓN	string	Requerido	string única de 24 dígitos hexadecimales que identifica la invitación.

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.

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

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Nombre	Tipo	Descripción
creado a las	string	Marca de tiempo en el formato de fecha y hora ISO 8601 en UTC cuando Ops Manager envió la invitación.
expira en	string	Marca de tiempo en ISO 8601 formato de fecha y hora en UTC cuando la invitación vence. Los usuarios tienen 30 días para aceptar una invitación a un proyecto de Ops Manager.
ID del grupo	string	string única de 24 dígitos hexadecimales que identifica el Proyecto.
groupName	string	Nombre del proyecto.
ID	string	string única de 24 dígitos hexadecimales que identifica la invitación.
inviterUsername	string	Usuario de Ops Manager que invitó a nombre de usuario al proyecto.
Roles	Arreglo de cadenas	Ops Manager roles para asignar al usuario invitado. Si el usuario acepta la invitación, Ops Manager asigna estos roles a él o ella.
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, utiliza esta dirección de correo electrónico como su nombre de usuario de Ops Manager.

Solicitud de ejemplo

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"

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

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	}