Salve uma configuração LDAP para seu projeto.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
atlas security ldap save [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--authenticationEnabled | false | Sinalizador que indica se a autenticação de usuário LDAP deve ser habilitada. | |
--authorizationEnabled | false | Sinalizador que indica se a autorização de usuário LDAP deve ser habilitada. | |
--authzQueryTemplate | string | false | Modelo de query LDAP formatado em RFC 4515 ou em formato RFC 4516 que o Atlas executa para obter os grupos de autorização LDAP aos quais o usuário autenticado pertence. Use o espaço reservado {USER} na URL para substituir o nome de usuário. A query é relativa ao host especificado com o nome do host. |
--bindPassword | string | false | Senha usada para autenticar o bindUsername. |
--bindUsername | string | true | Nome diferenciado (nome diferenciado) do usuário que o Atlas utiliza para se conectar ao servidor LDAP. Você deve formatar os nomes distintivos do LDAP de acordo com a RFC 2253. |
--caCertificate | string | false | Autoridade de certificação (CA) usada para verificar a identidade do servidor LDAP. Para excluir um valor atribuído, passe uma string vazia. |
-h, --help | false | ajuda para salvar | |
--hostname | string | true | Nome do host ou endereço IP do servidor LDAP. |
--mappingLdapQuery | string | false | Modelo de query LDAP formatado em RFC 4515 ou em formato RFC 4516 que insere o nome LDAP ao qual o regex corresponde em um URI de query LDAP. Mutuamente exclusivo com --mappingSubstituição, --mappingSubstituição. |
--mappingMatch | string | false | expressão regular (regex) formatada pelo ECMAScript para corresponder a um nome de usuário fornecido. |
--mappingSubstitution | string | false | Modelo de nome diferenciado (nome diferenciado) LDAP que converte o nome de usuário LDAP que corresponde ao regex especificado na opção de correspondência em um nome diferenciado LDAP. Mutuamente exclusivo com --mappingLdapQuery, --mappingLdapQuery. |
-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. |
--port | int | false | Porta que o servidor LDAP escuta para conexões de cliente. Este valor é padronizado para 636. |
--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. |
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. |
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.
HOSTNAME PORT AUTHENTICATION AUTHORIZATION <Ldap.Hostname> <Ldap.Port> <Ldap.AuthenticationEnabled> <Ldap.AuthorizationEnabled>
Exemplos
# Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com: atlas security ldap save --authenticationEnabled --authorizationEnabled --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe