Vista pública: por favor deja tu feedback: Devuelve un proveedor de identidades en la federación especificada por el ID del proveedor de identidades.
El subcomando de la API de Atlas, generado automáticamente a partir de la API de administración de MongoDB Atlas, ofrece cobertura total de la API de administración y actualmente se encuentra en Vista Previa Pública (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentación del endpoint de API proporcionado.
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.
Este comando se genera automáticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getidentityprovider.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api federatedAuthentication getIdentityProvider [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--envelope | envelope | 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 única de 24 dígitos hexadecimales que identifica su federación. |
-h, --ayuda | false | ayuda para getIdentityProvider | |
--identityProviderId | string | true | string única que identifica al proveedor de identidad con el que conectarse. Si se utiliza una versión de la API anterior a 11-15-2023, usa el id heredado de 20dígitos hexadecimales. Este id se puede encontrar en la Consola de gestión de la federación > pestaña Proveedor de identidad haciendo clic en el icono de información en la fila IdP ID de un proveedor de identidad configurado. Para todas las demás versiones, use el ID de dígito hexadecimal de 24. |
-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 utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8