Visualização pública: forneça comentários em: retorna os metadados de um provedor de identidade na federação especificada.
Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário da organização em uma das organizações conectadas.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Federated-Autenticação/operation/getIdentityProviderMetadata.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api federatedAuthentication getIdentityProviderMetadata [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--federationSettingsId | string | true | String exclusiva de 24 dígitos hexadecimais que identifica sua federação. |
-h, --help | false | ajuda para getIdentityProviderMetadata | |
--identityProviderId | string | true | String legada com 20 dígitos hexadecimais que identifica o provedor de identidade. Essa ID pode ser encontrada na guia Console de Gerenciamento de Federação > Provedores de Identidade, clicando no ícone de informações na linha ID do IdP de um provedor de identidade configurado. |
--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. |
Exemplos
Execute o comando abaixo.
atlas api federatedAuthentication getIdentityProviderMetadata --version 2023-01-01 --federationSettingsId 55fa922fb343282757d9554e --identityProviderId c2777a9eca931f29fc2f