Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
MongoDB Branding Shape
Click here >
Docs Menu

atlas api federatedAuthentication getIdentityProvider

Devuelve un proveedor de identidad en la federación especificada mediante el ID del proveedor de identidad.

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-getfederationsettingidentityprovider.

Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.

Sintaxis del comando
atlas api federatedAuthentication getIdentityProvider [options]
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 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 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-11-15"]. 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-11-15".

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.

atlas api federatedAuthentication getIdentityProvider --version 2023-11-15 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId 32b6e34b3d91647abb20e7b8