Recupera detalles de una invitación pendiente a la organización de Ops Manager especificada.
Roles necesarios
Puedes llamar a este endpoint con éxito si tienes el rol Organization User Admin.
Resource
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
GET /orgs/{ORG-ID}/invites/{INVITATION-ID}Parámetros de ruta de solicitud
Elemento de ruta | Tipo | Necesidad | Descripción |
|---|---|---|---|
ORG-ID | string | Requerido | string única de 24 dígitos hexadecimales que identifica a la organización. |
ID-DE-LA-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 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
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
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 | string | string única de 24 dígitos hexadecimales que identifica la invitación. |
inviterUsername | string | El usuario de Ops Manager que invitó a nombre de usuario a la organización. |
orgId | string | string única de 24 dígitos hexadecimales que identifica a la organización. |
orgName | string | Nombre de la organización. |
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. |
teamIds | Arreglo de cadenas | Cadenas únicas de 24 dígitos hexadecimales que identifican a los equipos a los que se invitó al usuario a unirse. |
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/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true"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 200 OKVary: 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-18T21:05:40Z", "expiresAt": "2021-03-20T21:05:40Z", "id": "{INVITATION-ID}", "inviterUsername": "admin@example.com", "orgId": "{ORG-ID}", "orgName": "{ORG-NAME}", "roles": [ "ORG_MEMBER" ], "teamIds": [], "username": "wyatt.smith@example.com"}