Actualiza una invitación pendiente por {INVITATION-ID} a la organización de Ops Manager que especifiques.
Usa el Obtener todas las invitaciones de la organización endpoint para recuperar los IDs de todas las invitaciones pendientes de la organización.
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
PATCH /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 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
Body Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
Roles | Arreglo de cadenas | Requerido | Ops Manager roles para asignar al usuario invitado. Si el usuario acepta la invitación, Ops Manager asigna estos roles a él o ella. ImportanteOps Manager reemplaza los roles en la invitación por los que proporciones en esta solicitud. Asegúrate de incluir todos los roles que desees asignar al usuario en esta solicitud. |
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 | 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
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --request PATCH "https://opsmanager.example.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \ 5 --data ' 6 { 7 "roles": [ 8 "ORG_OWNER" 9 ] 10 }'
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
1 { 2 "createdAt": "2021-02-18T21:05:40Z", 3 "expiresAt": "2021-03-20T21:05:40Z", 4 "id": "{INVITATION-ID}", 5 "inviterUsername": "admin@example.com", 6 "orgId": "{ORG-ID}", 7 "orgName": "{ORG-NAME}", 8 "roles": [ 9 "ORG_OWNER" 10 ], 11 "teamIds": [], 12 "username": "wyatt.smith@example.com" 13 }