experimental: retorna os metadados de um provedor de identidade na federação especificada.
Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização" em uma das organizações conectadas. Este comando está invocando o endpoint com OperationID: 'getIdentityProviderMetadata'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Authentication/operation/getIdentityProviderMetadata
Sintaxe
atlas api federatedAuthentication getIdentityProviderMetadata [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--federationSettingsId | string | true | string exclusiva de dígitos hexadecimais 24que identifica sua federação |
-h, --help | false | ajuda para getIdentityProviderMetadata | |
--identityProviderId | string | true | string legado de 20dígitos hexadecimais que identifica o provedor de identidade |
--output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--output-file | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |