# Nodeum API

## Get current LDAP config

> Get current LDAP config

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ldap_config":{"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"admin_path":{"type":"string"},"admin_password":{"type":"string"},"user_base_path":{"type":"string"},"user_filter_template":{"type":"string"}}}}},"paths":{"/ldap_config":{"get":{"summary":"Get current LDAP config","operationId":"get_ldap_config","description":"Get current LDAP config","responses":{"200":{"description":"Current config","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ldap_config"}}}}}}}}}
```

## Set LDAP config

> Set LDAP config

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ldap_config":{"type":"object","properties":{"id":{"type":"integer"},"host":{"type":"string"},"port":{"type":"integer"},"admin_path":{"type":"string"},"admin_password":{"type":"string"},"user_base_path":{"type":"string"},"user_filter_template":{"type":"string"}}}}},"paths":{"/ldap_config":{"post":{"summary":"Set LDAP config","operationId":"set_ldap_config","description":"Set LDAP config","responses":{"200":{"description":"Success or errorr","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"ok":{"type":"bool"}}},{"type":"object","properties":{"error":{"type":"string"}}}]}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ldap_config"}}},"required":true}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-mover/api-developers/api-reference-nodeum-data-mover/nodeum-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.