mongocli iam organização apiKeys create
Nesta página
Crie uma chave API para a sua organização.
O MongoDB retorna a chave de API privada apenas uma vez. Depois de executar este comando, copie, salve e proteja imediatamente a chave de API privada e pública.
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 da organização.
Sintaxe
mongocli iam organizations apiKeys create [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--desc | string | true | Descrição da chave API. |
-h, --help | false | ajuda para criar | |
--orgId | string | false | ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
-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. |
--role | strings | true | Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. To learn which values the CLI accepts, see the Items Enum for roles in the Atlas API spec: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey/. |
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 MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
API Key '<ID>' created. Public API Key <PublicKey> Private API Key <PrivateKey>
Exemplos
# Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: mongocli iam organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json