Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

projetos atlas convites descrever

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Retorne os detalhes do convite pendente especificado para o seu projeto.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de administrador do usuário do projeto.

Sintaxe do comando
atlas projects invitations describe <invitationId> [options]
Nome
Tipo
Obrigatório
Descrição
invitationId
string
true
String exclusiva de 24 dígitos que identifica o convite.
Nome
Tipo
Obrigatório
Descrição
-h, --help
false
ajuda para descrever
-o, --output
string
false
Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--projectId
string
false
String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.
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.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

ID USERNAME CREATED AT EXPIRES AT
<Id> <Username> <CreatedAt> <ExpiresAt>
# Return the JSON-formatted details of the pending invitation with the ID 5dd56c847a3e5a1f363d424d for the project with the ID 5f71e5255afec75a3d0f96dc:
atlas projects invitations describe 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --output json

Voltar

excluir

Próximo

convite