{"id":10861,"date":"2026-02-09T18:44:27","date_gmt":"2026-02-09T13:14:27","guid":{"rendered":"https:\/\/blog.tenthplanet.in\/?p=10861"},"modified":"2026-03-03T10:04:59","modified_gmt":"2026-03-03T10:04:59","slug":"pentaho-api-commands-directory-service-and-user-administration-2","status":"publish","type":"post","link":"https:\/\/tenthplanet.in\/blogs\/pentaho-api-commands-directory-service-and-user-administration-2\/","title":{"rendered":"Pentaho API Commands : Directory Service and User Administration"},"content":{"rendered":"\n<h1 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-bfc43fe8df2157fab301d816a59b3855\">Automate Administrative Tasks and Manage Pentaho Resources Programmatically<\/h1>\n\n\n\n<p>Pentaho 10.2 provides comprehensive REST API commands for directory service operations, user administration, and repository management. These API commands enable automation of administrative tasks, integration with external systems, and programmatic management of Pentaho resources.<\/p>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-934008d49a9578c40b46d94fe8dbc879\">Solution Architecture Overview<\/h2>\n\n\n\n<figure class=\"wp-block-image size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"576\" src=\"https:\/\/tenthplanet.in\/blogs\/wp-content\/uploads\/2026\/01\/pentaho_restapi_commands-1024x576.jpg\" alt=\"\" class=\"wp-image-10780\" srcset=\"https:\/\/tenthplanet.in\/blogs\/wp-content\/uploads\/sites\/21\/2026\/01\/pentaho_restapi_commands-1024x576.jpg 1024w, https:\/\/tenthplanet.in\/blogs\/wp-content\/uploads\/sites\/21\/2026\/01\/pentaho_restapi_commands-300x169.jpg 300w, https:\/\/tenthplanet.in\/blogs\/wp-content\/uploads\/sites\/21\/2026\/01\/pentaho_restapi_commands-768x432.jpg 768w, https:\/\/tenthplanet.in\/blogs\/wp-content\/uploads\/sites\/21\/2026\/01\/pentaho_restapi_commands.jpg 1280w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p>Learn about <a href=\"https:\/\/tenthplanet.in\/blogs\/pentaho-server-configuration-in-nginx-with-mutiple-domain-and-same-context-name-2\/\">Pentaho server configuration<\/a> or explore <a href=\"https:\/\/tenthplanet.in\/blogs\/pentaho-platform-what-pentaho-offers-out-of-the-box-2\/\">Pentaho platform<\/a> for comprehensive management solutions.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Integration<\/strong>: Integrate Pentaho with external systems and scripts<\/li>\n\n\n\n<li><strong>User management<\/strong>: Programmatically create, update, and manage users<\/li>\n\n\n\n<li><strong>Repository operations<\/strong>: Manage files, folders, and permissions via API<\/li>\n\n\n\n<li><strong>Access control<\/strong>: Configure ACLs and permissions programmatically<\/li>\n\n\n\n<li>Enables comprehensive data management capabilities<\/li>\n\n\n\n<li>Provides enhanced performance and reliability<\/li>\n<\/ul>\n\n\n\n<p>Note: All API commands should use HTTPS in production environments.<\/p>\n\n\n\n<p>Following are the Pentaho 10.2 API commands that can be used in terminal for various operations.<\/p>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-dd51cd3a1e80ce1b3a68852ec2de25b2\">Repository File Operations<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Command for displaying all folders and files under Pentaho user console home folder:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home\/tree?showHidden=true<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for displaying all folders and files under Pentaho user console public folder:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:public\/tree?showHidden=true<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for displaying specific folders and files Pentaho user console:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/pathofthefile\/tree?showHidden=true<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Creating a new file:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:stark:ex.xml<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Creating a new folder:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:flash\/createDir<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Deleting file\/folder:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT -d'folderid\/fileid' https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/delete<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-c09b3859528c1fd683cfe66859d46777\">Access Control List (ACL) Operations<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Command for displaying ACL of Folders:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:flash\/acl<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for displaying ACL of Files:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:flash:ex.xml\/acl<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for updating ACL of Folders:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -H \"Accept: application\/xml\" -H \"Content-Type: application\/xml\" -X PUT -d'&lt;?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?&gt;&lt;repositoryFileAclDto&gt;&lt;entriesInheriting&gt;false&lt;\/entriesInheriting&gt;&lt;id&gt;49393b98-b232-4d9c-8524-7911d9ce7b1c&lt;\/id&gt;&lt;owner&gt;admin&lt;\/owner&gt;&lt;ownerType&gt;0&lt;\/ownerType&gt;&lt;\/repositoryFileAclDto&gt;' https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:flash\/acl<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for updating ACL of Files:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -H \"Accept: application\/xml\" -H \"Content-Type: application\/xml\" -X PUT -d'&lt;?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?&gt;&lt;repositoryFileAclDto&gt;&lt;entriesInheriting&gt;false&lt;\/entriesInheriting&gt;&lt;id&gt;3d8470a0-3ffb-4fbc-82a2-74ebce0a322e&lt;\/id&gt;&lt;owner&gt;admin&lt;\/owner&gt;&lt;ownerType&gt;0&lt;\/ownerType&gt;&lt;\/repositoryFileAclDto&gt;' https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home:pentaho:tenthplanet:flash:ex.xml\/acl<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-80752f355b63a51c062aea445760e389\">User and Role Management Operations<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Command for creating users:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -H \"Accept: application\/xml\" -H \"Content-Type: application\/xml\" -X PUT -d'&lt;user&gt;&lt;userName&gt;john&lt;\/userName&gt;&lt;password&gt;password&lt;\/password&gt;&lt;\/user&gt;' https:\/\/localhost:8080\/pentaho\/api\/userroledao\/createUser<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Deleting users:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/userroledao\/deleteUsers?userNames=john<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Creating roles:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/userroledao\/createRole?roleName=report<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Deleting roles:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/userroledao\/deleteRoles?roleNames=report<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Assigning roles to users:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/userroledao\/assignRoleToUser?userName=john&amp;roleNames=report<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">Command for Removing roles of a users:<\/h3>\n\n\n\n<pre class=\"wp-block-code has-cyan-bluish-gray-background-color has-background\"><code>curl -u admin:password -X PUT https:\/\/localhost:8080\/pentaho\/api\/userroledao\/removeRoleFromUser?userName=john&amp;roleNames=report<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-191cc6c264c9a091a0ccbce54f8651f7\">Pentaho 10.2 Enhanced API Capabilities<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Authentication Methods<\/h3>\n\n\n\n<p><strong>Pentaho 10.2 REST API supports two primary authentication methods:<\/strong><\/p>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>Basic Authentication<\/strong> (shown in examples above)<\/li>\n<\/ol>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Username and password sent with each request<\/li>\n\n\n\n<li>Suitable for single service calls or clients that don&#8217;t support cookies<\/li>\n<\/ul>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>Cookie-Based Authentication<\/strong> (recommended for multiple calls)<\/li>\n<\/ol>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Authenticate once and receive a session cookie<\/li>\n\n\n\n<li>Use the cookie for subsequent requests<\/li>\n\n\n\n<li>More efficient for clients making multiple service calls<\/li>\n<\/ul>\n\n\n\n<p><strong>Example Cookie-Based Authentication:<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code># Step 1: Authenticate and get session cookie\ncurl -u admin:password -c cookies.txt -X POST https:\/\/localhost:8080\/pentaho\/api\/user\/authenticate\n\n# Step 2: Use cookie for subsequent requests\ncurl -b cookies.txt -X GET https:\/\/localhost:8080\/pentaho\/api\/repo\/files\/:home\/tree<\/code><\/pre>\n\n\n\n<p><strong>Note:<\/strong> System administrators can configure additional authentication options such as Single Sign-On (SSO) solutions like CAS for web-based access, but the REST API primarily uses Basic or Cookie-based authentication.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Security Best Practices<\/h3>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>Use HTTPS<\/strong> &#8211; Always use HTTPS in production (replace <code>http:\/\/<\/code> with <code>https:\/\/<\/code>)<\/li>\n\n\n\n<li><strong>Secure Credentials<\/strong> &#8211; Never hardcode passwords; use environment variables or secure credential stores<\/li>\n\n\n\n<li><strong>Cookie-Based Auth<\/strong> &#8211; Use cookie-based authentication for multiple API calls to reduce authentication overhead<\/li>\n\n\n\n<li><strong>Session Management<\/strong> &#8211; Properly manage session cookies and implement session timeout<\/li>\n\n\n\n<li><strong>Access Control<\/strong> &#8211; Implement proper access controls and permissions for API endpoints<\/li>\n<\/ol>\n\n\n\n<h3 class=\"wp-block-heading\">Performance Improvements<\/h3>\n\n\n\n<p><strong>Pentaho 10.2 API Performance:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>2-3x faster<\/strong> response times with Java 17<\/li>\n\n\n\n<li><strong>Improved connection pooling<\/strong> for better throughput<\/li>\n\n\n\n<li><strong>Enhanced caching<\/strong> for frequently accessed resources<\/li>\n\n\n\n<li><strong>Async operations<\/strong> for long-running tasks<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Key Benefits of Pentaho 10.2 API<\/h3>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>Improved Performance<\/strong>: 2-3x faster response times with Java 17<\/li>\n\n\n\n<li><strong>Modern Authentication<\/strong>: Cookie-based authentication for efficient multi-call scenarios<\/li>\n\n\n\n<li><strong>Secure Access<\/strong>: HTTPS support and secure credential management<\/li>\n\n\n\n<li><strong>Scalability<\/strong>: Docker and Kubernetes support for auto-scaling<\/li>\n\n\n\n<li><strong>Comprehensive Management<\/strong>: Repository, user, role, and ACL management via API<\/li>\n\n\n\n<li><strong>Integration Ready<\/strong>: RESTful design enables integration with external systems<\/li>\n<\/ol>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n\n\n\n<h2 class=\"wp-block-heading\">Frequently Asked Questions<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">What are Pentaho API commands used for?<\/h3>\n\n\n\n<p>Pentaho API commands enable automation of administrative tasks, integration with external systems, and programmatic management of Pentaho resources including directory service operations, user administration, role management, repository management, and ACL (Access Control List) management.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">How do I authenticate with Pentaho API?<\/h3>\n\n\n\n<p>Pentaho 10.2 API uses cookie-based authentication for efficient multi-call scenarios. Authentication requires valid credentials and supports HTTPS for secure access. API commands should be executed with appropriate security measures including secure credential management and proper access controls.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">What administrative tasks can be automated with Pentaho API?<\/h3>\n\n\n\n<p>Pentaho API enables automation of directory service operations (user creation, role assignment), user administration (user management, password reset), repository management (file operations, folder management), and ACL management (permission assignment, access control).<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Does Pentaho API support integration with external systems?<\/h3>\n\n\n\n<p>Yes. Pentaho 10.2 API uses RESTful design enabling integration with external systems. The API supports standard HTTP methods (GET, POST, PUT, DELETE) and JSON responses, making it easy to integrate with automation tools, CI\/CD pipelines, and external management systems.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">What are the benefits of Pentaho 10.2 API?<\/h3>\n\n\n\n<p>Key benefits include improved performance (2-3x faster with Java 17), modern authentication (cookie-based), secure access (HTTPS support), scalability (Docker and Kubernetes support), comprehensive management (repository, user, role, ACL), and integration readiness (RESTful design).<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">How does Pentaho API ensure security?<\/h3>\n\n\n\n<p>Pentaho API ensures security through HTTPS support, secure credential management, proper access controls, authentication requirements, and secure session management. All API commands should be executed with appropriate security measures in production environments.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Can Pentaho API be used for repository management?<\/h3>\n\n\n\n<p>Yes. Pentaho API provides comprehensive repository management capabilities including file operations (create, read, update, delete), folder management, repository navigation, and content management. API commands enable programmatic repository operations for automation and integration.<\/p>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n\n\n\n<h2 class=\"wp-block-heading has-vivid-cyan-blue-color has-text-color has-link-color wp-elements-e23cc87e09ff551060ea84eadabd9635\">\ud83c\udfaf Ready to automate Pentaho administrative tasks?<\/h2>\n\n\n\n<p>Pentaho 10.2 API commands enable automation of administrative tasks, integration with external systems, and programmatic management of Pentaho resources. Learn how to use Pentaho API for directory service operations, user administration, and repository management.<\/p>\n\n\n\n<p><a href=\"https:\/\/tenthplanet.in\/getintouch\/\">Contact TenthPlanet<\/a> for expert Pentaho API integration and automation services.<\/p>\n\n\n\n<p>Note: All API commands should be executed with appropriate security measures. In production environments, use HTTPS, secure credential management, and implement proper access controls. Pentaho 10.2 provides improved performance with Java 17 and supports modern deployment options including Docker and Kubernetes.<\/p>\n\n\n\n<p><strong>Related Resources:<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/tenthplanet.in\/resources\/category\/pentaho\/#casestudies\">TenthPlanet Case Studies<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/tenthplanet.in\/pentaho\/services\/\">TenthPlanet Pentaho Services<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/tenthplanet.in\/getintouch\/\">Contact TenthPlanet<\/a><\/li>\n<\/ul>\n\n\n\n<hr class=\"wp-block-separator has-alpha-channel-opacity\" \/>\n","protected":false},"excerpt":{"rendered":"<p>Automate Administrative Tasks and Manage Pentaho Resources Programmatically Pentaho 10.2 provides comprehensive REST API commands for directory service operations, user [&hellip;]<\/p>\n","protected":false},"author":23,"featured_media":11183,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[424],"tags":[735,589,736,737,738,739],"class_list":["post-10861","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-pentaho","tag-pentaho-api","tag-pentaho-api-commands","tag-pentaho-automation","tag-pentaho-directory-service","tag-pentaho-rest-api","tag-pentaho-user-administration"],"acf":[],"_links":{"self":[{"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/posts\/10861","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/users\/23"}],"replies":[{"embeddable":true,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/comments?post=10861"}],"version-history":[{"count":0,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/posts\/10861\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/media\/11183"}],"wp:attachment":[{"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/media?parent=10861"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/categories?post=10861"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/tenthplanet.in\/blogs\/wp-json\/wp\/v2\/tags?post=10861"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}