Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / / /

atlas API federatedAuthentication listConnectedOrgConfigs

Visualização pública: forneça feedback em: retorna todas as configurações de organização conectadas na federação especificada.

Para usar esse recurso, a chave de API solicitante deve ter a função "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/listConnectedOrgConfigs.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe do comando
atlas api federatedAuthentication listConnectedOrgConfigs [options]
Nome
Tipo
Obrigatório
Descrição

--envelope

envelope

false

Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.

--federationSettingsId

string

true

String exclusiva de 24 dígitos hexadecimais que identifica sua federação.

-h, --help

false

ajuda para listConnectedOrgConfigs

--itemsPerPage

int

false

Número de itens que a resposta retorna por página.

--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)

--pageNum

int

false

Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

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

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

Execute o comando abaixo.

atlas api federatedAuthentication listConnectedOrgConfigs --version 2023-01-01 --envelope false --federationSettingsId 55fa922fb343282757d9554e --itemsPerPage 100 --pageNum 1

Nesta página