Actualiza una invitación pendiente de {INVITATION-ID} a la organización Cloud Manager que especifiques.
Utiliza el endpoint Obtener todas las invitaciones de la organización para recuperar los ID 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://cloud.mongodb.com/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 muestra si se debe devolver el cuerpo de la respuesta en un prettyprint formato. |
|
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, establezca 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 | Cloud Manager roles para asignar al usuario invitado. Si el usuario acepta la invitación, Cloud Manager les asigna estos roles. IMPORTANTE: Cloud Manager sustituye los roles en la invitación por los roles que facilitas en esta solicitud. Asegúrese de incluir en esta solicitud todos los roles que desee asignar al usuario. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
creado a las | string | Marca de tiempo en formato de fecha y hora ISO 8601 en UTC cuando Cloud 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 Cloud Manager. |
ID | string | string única de 24 dígitos hexadecimales que identifica la invitación. |
inviterUsername | string | Usuario de Cloud 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 | Cloud Manager roles para asignar al usuario invitado. Si el usuario acepta la invitación, Cloud Manager les asigna estos roles. |
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 Cloud 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 Cloud Manager. |
Solicitud de ejemplo
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \ --data ' { "roles": [ "ORG_OWNER" ] }'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_OWNER" ], "teamIds": [], "username": "wyatt.smith@example.com"}