/ /

Organizaciones

Docs Home

/ /

Organizaciones y equipos

Organizaciones y equipos

Organizaciones

Actualizar una invitación de organización por el ID de invitación

Cloud Manager dejará de admitir la Automatización, la Copia de seguridad y la Supervisión para MongoDB 3.6 y 4.0 después del 30de agosto de 2024. Por favor actualiza tu implementación de MongoDB o migra a Atlas.

Actualiza una invitación pendiente por {INVITATION-ID} a la organización Cloud Manager que usted especifique.

Usa el Obtenga el punto final de todas las invitaciones de la organización para recuperar los ID de todas las invitaciones de la organización pendientes.

Roles necesarios

Puede llamar a este punto final con éxito con 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 la ruta de solicitud

Elemento de ruta	Tipo	Necesidad	Descripción
ORG-ID	string	Requerido	Cadena única de 24 dígitos hexadecimales que identifica a la organización.
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 respuesta debe estar en un prettyprint 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

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 le asigna estos roles. IMPORTANTE: Cloud Manager reemplaza los roles de la invitación con los que proporcione en esta solicitud. Asegúrese de incluir todos los roles que desea asignar al usuario en esta solicitud.

Respuesta

Nombre	Tipo	Descripción
creado a las	string	Marca de tiempo en ISO 8601 formato de fecha y hora 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 vence. 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	Cadena ú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 le 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

1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2      --header "Accept: application/json" \
3      --header "Content-Type: application/json" \
4      --request PATCH "https://cloud.mongodb.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

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-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 }

Volver

Consigue una Invitación

Actualizar invitación

1	curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest --include \
2	--header "Accept: application/json" \
3	--header "Content-Type: application/json" \
4	--request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/invites/{INVITATION-ID}?pretty=true" \
5	--data '
6	{
7	"roles": [
8	"ORG_OWNER"
9	]
10	}'

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	}