Retorna todos los proveedores de identidad con el protocolo y tipo proporcionados 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.
Si no se especifica ningún protocolo, sólo se devolverán proveedores de identidad SAML. Si no se especifica un idpType, solo se devolverán los proveedores de identidad WORKFORCE. 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 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operación-listfederationsettingidentityproviders.
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 listIdentityProviders [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--envelope | envelope | false | Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. 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 | string única de 24 dígitos hexadecimales que identifica a tu federación. |
-h, --help | false | ayuda para listIdentityProviders | |
--idpType | stringArray | false | Los tipos de los proveedores de identidad de destino. |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
-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) |
--número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--protocol | stringArray | false | Los protocolos de los proveedores de identidad objetivo. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01". |
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 listIdentityProviders --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e