> For the complete documentation index, see [llms.txt](https://docs.pentaho.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pentaho.com/rest-api/user-role-management-apis-ldap-resource.md). # User Role Management APIs LDAP Resource Resource allows reading and updating LDAP settings. ## Get LDAP attributes > Retrieve the LDAP attributes of the repository.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > GET pentaho/api/ldap/config/getAttributeValues\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X GET \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\ > -H "Accept: application/json"\ > \`\`\`\ > \ > \*\*Example Response:\*\*\ > \`\`\`json\ > {\ > "attributes": \[\ > {\ > "key": "allAuthoritiesSearch.searchBase",\ > "value": "ou=roles"\ > },\ > {\ > "key": "allUsernamesSearch.searchBase",\ > "value": "ou=users"\ > },\ > {\ > "key": "userSearch.searchFilter",\ > "value": "(cn={0})"\ > },\ > {\ > "key": "securityProvider",\ > "value": "jackrabbit"\ > },\ > {\ > "key": "populator.groupRoleAttribute",\ > "value": "cn"\ > },\ > {\ > "key": "allUsernamesSearch.usernameAttribute",\ > "value": "uid"\ > },\ > {\ > "key": "populator.groupSearchBase",\ > "value": "ou=roles"\ > },\ > {\ > "key": "contextSource.providerUrl",\ > "value": "ldap\://localhost:10389/ou=system"\ > },\ > {\ > "key": "populator.searchSubtree",\ > "value": "false"\ > },\ > {\ > "key": "allUsernamesSearch.searchFilter",\ > "value": "objectClass=Person"\ > },\ > {\ > "key": "populator.convertToUpperCase",\ > "value": "false"\ > },\ > {\ > "key": "populator.rolePrefix",\ > "value": ""\ > },\ > {\ > "key": "contextSource.password",\ > "value": "secret"\ > },\ > {\ > "key": "userSearch.searchBase",\ > "value": "ou=users"\ > },\ > {\ > "key": "allAuthoritiesSearch.roleAttribute",\ > "value": "cn"\ > },\ > {\ > "key": "adminUser",\ > "value": "uid=admin,ou=users"\ > },\ > {\ > "key": "contextSource.userDn",\ > "value": "uid=admin,ou=system"\ > },\ > {\ > "key": "allAuthoritiesSearch.searchFilter",\ > "value": "(objectClass=organizationalRole)"\ > },\ > {\ > "key": "populator.groupSearchFilter",\ > "value": "(roleOccupant={0})"\ > },\ > {\ > "key": "adminRole",\ > "value": "cn=Administrator,ou=roles"\ > }\ > ]\ > }\ > \`\`\`\ > \ > \*\*Returns:\*\*\ > An AttributeSet object containing LDAP attributes of the repository.
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"User Role Management APIs - LDAP Resource","description":"Resource allows reading and updating LDAP settings."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/ldap/config/getAttributeValues":{"get":{"tags":["User Role Management APIs - LDAP Resource"],"summary":"Get LDAP attributes","produces":["application/json"],"description":"Retrieve the LDAP attributes of the repository.\n\n**Example Request:**\n```\nGET pentaho/api/ldap/config/getAttributeValues\n```\n\n**cURL Example:**\n```bash\ncurl -X GET \\\n \"http://localhost:8080/pentaho/api/ldap/config/getAttributeValues\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n -H \"Accept: application/json\"\n```\n\n**Example Response:**\n```json\n{\n \"attributes\": [\n {\n \"key\": \"allAuthoritiesSearch.searchBase\",\n \"value\": \"ou=roles\"\n },\n {\n \"key\": \"allUsernamesSearch.searchBase\",\n \"value\": \"ou=users\"\n },\n {\n \"key\": \"userSearch.searchFilter\",\n \"value\": \"(cn={0})\"\n },\n {\n \"key\": \"securityProvider\",\n \"value\": \"jackrabbit\"\n },\n {\n \"key\": \"populator.groupRoleAttribute\",\n \"value\": \"cn\"\n },\n {\n \"key\": \"allUsernamesSearch.usernameAttribute\",\n \"value\": \"uid\"\n },\n {\n \"key\": \"populator.groupSearchBase\",\n \"value\": \"ou=roles\"\n },\n {\n \"key\": \"contextSource.providerUrl\",\n \"value\": \"ldap://localhost:10389/ou=system\"\n },\n {\n \"key\": \"populator.searchSubtree\",\n \"value\": \"false\"\n },\n {\n \"key\": \"allUsernamesSearch.searchFilter\",\n \"value\": \"objectClass=Person\"\n },\n {\n \"key\": \"populator.convertToUpperCase\",\n \"value\": \"false\"\n },\n {\n \"key\": \"populator.rolePrefix\",\n \"value\": \"\"\n },\n {\n \"key\": \"contextSource.password\",\n \"value\": \"secret\"\n },\n {\n \"key\": \"userSearch.searchBase\",\n \"value\": \"ou=users\"\n },\n {\n \"key\": \"allAuthoritiesSearch.roleAttribute\",\n \"value\": \"cn\"\n },\n {\n \"key\": \"adminUser\",\n \"value\": \"uid=admin,ou=users\"\n },\n {\n \"key\": \"contextSource.userDn\",\n \"value\": \"uid=admin,ou=system\"\n },\n {\n \"key\": \"allAuthoritiesSearch.searchFilter\",\n \"value\": \"(objectClass=organizationalRole)\"\n },\n {\n \"key\": \"populator.groupSearchFilter\",\n \"value\": \"(roleOccupant={0})\"\n },\n {\n \"key\": \"adminRole\",\n \"value\": \"cn=Administrator,ou=roles\"\n }\n ]\n}\n```\n\n**Returns:**\nAn AttributeSet object containing LDAP attributes of the repository.\n","responses":{"200":{"description":"Successfully retrieved the LDAP attributes of the repository","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"LDAP attribute key"},"value":{"type":"string","description":"LDAP attribute value"}}}}}}}}},"500":{"description":"Server Error"}}}}}} ```` ## Set LDAP attributes > Writes LDAP attributes with new authentication parameters.\ > \ > \*\*Example Request:\*\*\ > \`\`\`\ > PUT pentaho/api/ldap/config/setAttributeValues\ > \`\`\`\ > \ > \*\*PUT data:\*\*\ > \`\`\`json\ > {\ > "attributes": \[\ > {\ > "key": "allAuthoritiesSearch.searchBase",\ > "value": "ou=roles"\ > },\ > {\ > "key": "allUsernamesSearch.searchBase",\ > "value": "ou=users"\ > },\ > {\ > "key": "userSearch.searchFilter",\ > "value": "(cn={0})"\ > },\ > {\ > "key": "securityProvider",\ > "value": "jackrabbit"\ > },\ > {\ > "key": "populator.groupRoleAttribute",\ > "value": "cn"\ > },\ > {\ > "key": "allUsernamesSearch.usernameAttribute",\ > "value": "uid"\ > },\ > {\ > "key": "populator.groupSearchBase",\ > "value": "ou=roles"\ > },\ > {\ > "key": "contextSource.providerUrl",\ > "value": "ldap\://localhost:10389/ou=system"\ > },\ > {\ > "key": "populator.searchSubtree",\ > "value": "false"\ > },\ > {\ > "key": "allUsernamesSearch.searchFilter",\ > "value": "objectClass=Person"\ > },\ > {\ > "key": "populator.convertToUpperCase",\ > "value": "false"\ > },\ > {\ > "key": "populator.rolePrefix",\ > "value": ""\ > },\ > {\ > "key": "contextSource.password",\ > "value": "secret"\ > },\ > {\ > "key": "userSearch.searchBase",\ > "value": "ou=users"\ > },\ > {\ > "key": "allAuthoritiesSearch.roleAttribute",\ > "value": "cn"\ > },\ > {\ > "key": "adminUser",\ > "value": "uid=admin,ou=users"\ > },\ > {\ > "key": "contextSource.userDn",\ > "value": "uid=admin,ou=system"\ > },\ > {\ > "key": "allAuthoritiesSearch.searchFilter",\ > "value": "(objectClass=organizationalRole)"\ > },\ > {\ > "key": "populator.groupSearchFilter",\ > "value": "(roleOccupant={0})"\ > },\ > {\ > "key": "adminRole",\ > "value": "cn=Administrator,ou=roles"\ > }\ > ]\ > }\ > \`\`\`\ > \ > \*\*cURL Example:\*\*\ > \`\`\`bash\ > curl -X PUT \\\ > "" \\\ > -H "Authorization: Basic YWRtaW46cGFzc3dvcmQ=" \\\ > -H "Content-Type: application/json" \\\ > -d '{\ > "attributes": \[\ > {\ > "key": "allAuthoritiesSearch.searchBase",\ > "value": "ou=roles"\ > },\ > {\ > "key": "allUsernamesSearch.searchBase",\ > "value": "ou=users"\ > }\ > ]\ > }'\ > \`\`\`\ > \ > \*\*Example Response:\*\*\ > \`\`\`\ > This response does not contain data.\ > \`\`\`\ > \ > \*\*Returns:\*\*\ > A jax-rs Response object with the appropriate status code, header, and body.
````json {"openapi":"3.0.3","info":{"title":"Pentaho Data Integration and Analytics","version":"0.0.1"},"tags":[{"name":"User Role Management APIs - LDAP Resource","description":"Resource allows reading and updating LDAP settings."}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic Authentication"}}},"paths":{"/ldap/config/setAttributeValues":{"put":{"tags":["User Role Management APIs - LDAP Resource"],"summary":"Set LDAP attributes","consumes":["application/json"],"description":"Writes LDAP attributes with new authentication parameters.\n\n**Example Request:**\n```\nPUT pentaho/api/ldap/config/setAttributeValues\n```\n\n**PUT data:**\n```json\n{\n \"attributes\": [\n {\n \"key\": \"allAuthoritiesSearch.searchBase\",\n \"value\": \"ou=roles\"\n },\n {\n \"key\": \"allUsernamesSearch.searchBase\",\n \"value\": \"ou=users\"\n },\n {\n \"key\": \"userSearch.searchFilter\",\n \"value\": \"(cn={0})\"\n },\n {\n \"key\": \"securityProvider\",\n \"value\": \"jackrabbit\"\n },\n {\n \"key\": \"populator.groupRoleAttribute\",\n \"value\": \"cn\"\n },\n {\n \"key\": \"allUsernamesSearch.usernameAttribute\",\n \"value\": \"uid\"\n },\n {\n \"key\": \"populator.groupSearchBase\",\n \"value\": \"ou=roles\"\n },\n {\n \"key\": \"contextSource.providerUrl\",\n \"value\": \"ldap://localhost:10389/ou=system\"\n },\n {\n \"key\": \"populator.searchSubtree\",\n \"value\": \"false\"\n },\n {\n \"key\": \"allUsernamesSearch.searchFilter\",\n \"value\": \"objectClass=Person\"\n },\n {\n \"key\": \"populator.convertToUpperCase\",\n \"value\": \"false\"\n },\n {\n \"key\": \"populator.rolePrefix\",\n \"value\": \"\"\n },\n {\n \"key\": \"contextSource.password\",\n \"value\": \"secret\"\n },\n {\n \"key\": \"userSearch.searchBase\",\n \"value\": \"ou=users\"\n },\n {\n \"key\": \"allAuthoritiesSearch.roleAttribute\",\n \"value\": \"cn\"\n },\n {\n \"key\": \"adminUser\",\n \"value\": \"uid=admin,ou=users\"\n },\n {\n \"key\": \"contextSource.userDn\",\n \"value\": \"uid=admin,ou=system\"\n },\n {\n \"key\": \"allAuthoritiesSearch.searchFilter\",\n \"value\": \"(objectClass=organizationalRole)\"\n },\n {\n \"key\": \"populator.groupSearchFilter\",\n \"value\": \"(roleOccupant={0})\"\n },\n {\n \"key\": \"adminRole\",\n \"value\": \"cn=Administrator,ou=roles\"\n }\n ]\n}\n```\n\n**cURL Example:**\n```bash\ncurl -X PUT \\\n \"http://localhost:8080/pentaho/api/ldap/config/setAttributeValues\" \\\n -H \"Authorization: Basic YWRtaW46cGFzc3dvcmQ=\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"attributes\": [\n {\n \"key\": \"allAuthoritiesSearch.searchBase\",\n \"value\": \"ou=roles\"\n },\n {\n \"key\": \"allUsernamesSearch.searchBase\",\n \"value\": \"ou=users\"\n }\n ]\n }'\n```\n\n**Example Response:**\n```\nThis response does not contain data.\n```\n\n**Returns:**\nA jax-rs Response object with the appropriate status code, header, and body.\n","requestBody":{"required":true,"description":"An AttributeSet representing the new authentication parameters","content":{"application/json":{"schema":{"type":"object","properties":{"attributes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"LDAP attribute key"},"value":{"type":"string","description":"LDAP attribute value"}}}}}}}}},"responses":{"200":{"description":"Successfully updated the LDAP attributes of the repository"},"500":{"description":"Server Error"}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## 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, and the optional `goal` query parameter: ``` GET https://docs.pentaho.com/rest-api/user-role-management-apis-ldap-resource.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.