Verificar a configuração LDAP em um projeto
Verifica a configuração LDAP para o projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.
parâmetros de caminho
-
Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.
AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
O formato deve corresponder ao seguinte padrão:
^([a-f0-9]{24})$.
parâmetros de query
-
Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON
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 consulta. 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.O valor padrão é
false. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint
corpo, corpo
Obrigatório
A configuração LDAP do projeto especificado que você deseja validar.
-
Modelo de query LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud aplica para criar uma query LDAP para retornar os grupos LDAP associados ao usuário autenticado do MongoDB. O MongoDB Cloud usa este parâmetro apenas para a autorização do usuário.
Use o
{USER}espaço reservado no Localizador de recursos uniforme (URL) para substituir o nome de usuário autenticado. A query está relacionada ao host especificado com o nome do host. Formate esta consulta por RFC 4515 e RFC 4516.O valor padrão é
{USER}?memberOf?base. -
Senha que o MongoDB Cloud usa para autenticar o bindUsername.
-
Nome distintivo (DN) completo do usuário LDAP (Lightweight Directory Access Protocol) que o MongoDB Cloud usa para se conectar ao host LDAP. Os nomes distintivos do LDAP devem ser formatados de acordo com a RFC 2253.
O formato deve corresponder ao seguinte padrão:
^(?:(?<cn>CN=(?<name>[^,]*)),)?(?:(?<path>(?:(?:CN|OU)=[^,]+,?)+),)?(?<domain>(?:DC=[^,]+,?)+)$.RFC 2253 -
Certificado de autoridade de certificação (CA) que o MongoDB Cloud usa para verificar a identidade do host LDAP (Lightweight Directory Access Protocol). MongoDB Cloud permite certificados autoassinados. Para excluir um valor atribuído, passe uma string vazia:
"caCertificate": "". -
Etiqueta legível por humanos que identifica o nome do host ou o endereço IP (Internet Protocol) do host LDAP (Lightweight Directory Access Protocol). Esse host deve ter acesso à Internet ou ter uma conexão de emparelhamento de nuvem privada virtual (VPC) com seu cluster.
O formato deve corresponder ao seguinte padrão:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$. -
Porta IANA para a qual o host LDAP (Lightweight Directory Access Protocol) escuta conexões de cliente.
O valor padrão é
636.
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/userSecurity/ldap/verify' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"authzQueryTemplate":"{USER}?memberOf?base","bindPassword":"string","bindUsername":"CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com","caCertificate":"string","hostname":"string","port":636}'{
"authzQueryTemplate": "{USER}?memberOf?base",
"bindPassword": "string",
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"port": 636
}{
"groupId": "32b6e34b3d91647abb20e7b8",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"request": {
"bindUsername": "CN=BindUser,CN=Users,DC=myldapserver,DC=mycompany,DC=com",
"caCertificate": "string",
"hostname": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"port": 636
},
"requestId": "32b6e34b3d91647abb20e7b8",
"status": "FAIL",
"validations": [
{
"status": "FAIL",
"validationType": "AUTHENTICATE"
}
]
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}