Devuelve los metadatos de un proveedor de identidad en la federación especificada.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Para utilizar este recurso, la cuenta de servicio solicitante o la clave API debe tener el rol de Propietario de la Organización en una de las organizaciones conectadas.
Este comando se genera automáticamente y corresponde a 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getfederationsettingidentityprovidermetadata.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api federatedAuthentication getIdentityProviderMetadata [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--federationSettingsId | string | true | string única de 24 dígitos hexadecimales que identifica a tu federación. |
-h, --help | false | ayuda para getIdentityProviderMetadata | |
--identityProviderId | string | true | string de dígitos hexadecimales de 20heredada que identifica al proveedor de identidad. Este id se puede encontrar dentro de la Consola de Gestión de Federaciones > pestaña Proveedores de Identidad haciendo clic en el icono de información en la fila IdP ID de un proveedor de identidad configurado. |
-o, --output | string | false | formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON". |
--outputFile | 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 la API que se debe usar al llamar a los endpoints de la API de Atlas [opciones: "2023-01-01"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil a usar de tu archivo de configuración. Para aprender sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api federatedAuthentication getIdentityProviderMetadata --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId c2777a9eca931f29fc2f