- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Enumere los proveedores de identidad de su configuración de federación.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). 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 comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de Propietario de la organización.
Sintaxis
atlas federatedAuthentication federationSettings identityProvider list [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--federationSettingsId | string | true | Cadena de dígitos hexadecimales 24única que identifica la configuración de la federación. |
-h, --ayuda | false | ayuda para la lista | |
--idpType | string | false | Tipo de proveedor de identidad. Los valores válidos son WORKFORCE o WORKLOAD. El valor predeterminado es "WORKFORCE". |
--limit | Int | false | Número de elementos por página de resultados, hasta un máximo de 500. Si tiene más de 500 resultados, especifique la opción --page para cambiar la página de resultados. El valor predeterminado es 100. |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--page | Int | false | Número de página que especifica una página de resultados. Este valor es por defecto 1. |
--protocol | string | false | Protocolo utilizado para autenticar al usuario. El valor válido es OIDC o SAML. El valor predeterminado es "OIDC". |
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. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
ID DISPLAY NAME ISSUER URI CLIENT ID IDP TYPE <Id> <DisplayName> <IssuerUri> <ClientId> <IdpType>
Ejemplos
# List the identity providers from your federation settings with federationSettingsId 5d1113b25a115342acc2d1aa and idpType WORKLOAD atlas federatedAuthentication federationSettings identityProvider list --federationSettingsId 5d1113b25a115342acc2d1aa --idpType WORKLOAD