Recupere los detalles de una invitación pendiente al proyecto Ops Manager especificado.
Si Bypass Invitation Mode está habilitado, MongoDB Atlas añade el usuario al proyecto inmediatamente y no devuelve una invitación para ese usuario.
Roles necesarios
Puede llamar con éxito a este endpoint con el rol de Project User Admin.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /groups/{GROUP-ID}/invites/Parámetros de 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. |
Parámetros de Solicitud Query
Los siguientes parámetros de query son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
bonito | booleano | Opcional | Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print. |
|
envelope | booleano | Opcional | Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta 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
Nombre | Tipo | Descripción |
|---|---|---|
Roles | Arreglo de cadenas | Lista de roles de proyecto de Ops Manager que se asignarán al usuario invitado. Si el usuario acepta la invitación, Ops Manager les asigna estos roles. Especifique uno o más de los siguientes valores:
|
Nombre de usuario | string | Dirección de correo electrónico a la que Ops Manager envió la invitación. El usuario utiliza esta dirección de correo electrónico como su nombre de usuario de Ops Manager si acepta esta invitación. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
creado a las | string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando MongoDB 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 caduca. 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" \ --header "Content-Type: application/json" \ --request POST "https://opsmanager.example.com/api/public/v1.0/groups/{GROUP-ID}/invites?pretty=true" \ --data ' { "roles": [ "GROUP_OWNER" ], "username": "jane.doe@example.com" }'Respuesta de ejemplo
Encabezado de respuesta
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}Respuesta del cuerpo
{ "createdAt": "2021-02-18T18:51:46Z", "expiresAt": "2021-03-20T18:51:46Z", "groupId": "{GROUP-ID}", "groupName": "group", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "roles": [ "GROUP_OWNER" ], "username": "jane.smith@example.com"}