Visualização pública: forneça feedback em: retorna os detalhes de um convite pendente para a organização especificada.
Para usar esse recurso, a chave API solicitada deve ter a role Proprietário da organização.
Observação: as APIs de gerenciamento de convites estão descontinuadas. Use Retornar um usuário do MongoDB Cloud em uma organização para retornar um usuário pendente.
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/Organizations/operation/getOrganizationInvitation.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api organizations getOrganizationInvitation [options]
Opções
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. |
-h, --help | false | ajuda para getOrganizationInvitation | |
--invitationId | string | true | String exclusiva de 24 dígitos hexadecimais que identifica o convite. |
--orgId | string | true | String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
--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 organizations getOrganizationInvitation --version 2023-01-01 --envelope false --invitationId [invitationId] --orgId 4888442a3354817a7320eb61