Revoca los tokens JWKS del proveedor de identidad OIDC solicitado.
El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario de la organización en una de las organizaciones conectadas.
Nota: Al revocar sus tokens JWKS, se actualizan inmediatamente las claves públicas de su IdP en todos sus clústeres de Atlas, lo que invalida los tokens de acceso previamente firmados y cierra la sesión de todos los usuarios. Es posible que deba reiniciar sus clientes de MongoDB. Todas las organizaciones conectadas al proveedor de identidad se verán afectadas.
Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-revokefederationsettingidentityproviderjwks.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api federatedAuthentication revokeIdentityProviderJwks [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
--federationSettingsId | string | true | Cadena de dígitos hexadecimales 24única que identifica su federación. |
-h, --ayuda | false | Ayuda para revokeIdentityProviderJwks | |
--identityProviderId | string | true | string única de 24 dígitos hexadecimales que identifica al proveedor de identidad para conectar. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-11-15"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-11-15". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api federatedAuthentication revokeIdentityProviderJwks --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8