--- title: "Web API commands for the User Directory" slug: "web-api-commands-for-the-user-directory-1" updated: 2026-09-12T18:55:41Z published: 2026-09-12T18:55:41Z canonical: "docs.trellix.com/web-api-commands-for-the-user-directory-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # Web API commands for the User Directory Once you install the **`UserDirectory.zip`** extension into the Trellix ePO - On-prem server, you can create users and groups, and manage them using these Web API commands, without requiring to register an LDAP server in Trellix ePO - On-prem. | Command | Syntax | | | --- | --- | --- | | userdirectory.addEditAttribute | **` userdirectory.addEditAttribute`** **` itemId=<> or itemDn=<>`** **`stringAttributes=<>`** | **`itemId=<>`** — Refers to the item(s) whose attributes need to be edited. **`stringAttributes=<>`** — Name of the attribute(s) that needs to be edited or added. | | userdirectory.addItem | **`userdirectory.addItem`** **`parentDn/parentId=<>`** **`itemName=<>`** **`itemType<>`** | **`parentDn/parentId=<>`** — The Parent DN/ ID can be taken from the database or the user interface. **`itemName=<>`**— Name of the item **` itemType=<>`**— User or Group | | userdirectory.deleteItem | **`userdirectory.deleteItem`** **` itemDn/itemId=<>`** | **`itemDn/itemId=<>`** — Refers to the item that needs to be deleted. | | userdirectory.getAttribute | **`userdirectory.getAttribute `** **`itemDn/itemId=<>`** **`attribName=<>`** | **`itemDn/itemId=<>`** — Refers to the item whose attribute details are retrieved. **`attribName=<>`** — Name of the attribute. | | userdirectory.deleteAttribute | **`userdirectory.deleteAttribute `** **`itemDn/itemId=<>`** **`attribName=<>`** | **`itemDn/itemId=<>`** — Refers to the item whose attribute needs to be deleted. **`attribName=<>`** — Name of the attribute that needs to be deleted. | | userdirectory.enableItem | **`userdirectory.enableItem`** **`itemId/itemDn=<> `** **`enabled=<>`** | **`itemId/itemDn=<>`** — Refers to the item that needs to be enabled/disabled. **`enabled=<>`** — True enables the item. False disables the item. | | userdirectory.moveItem | **`userdirectory.moveItem `** **`itemDn/itemId=<>`** **` parentFqdn/parentId=<>`** | **`itemDn/itemId=<>`** — Refers to the item that needs to be moved. **` parentFqdn/parentId=<>`** — Parent FQDN/ ID can be taken from the database or the user interface. | | userdirectory.renameItem | **`userdirectory.renameItem `** **`itemDn/itemId=<> `** **`newName=<>`** | **`itemDn/itemId=<>`** — Refers to the item that needs to be renamed. **`newName=<>`** — Refers to the new name for the item | | userdirectory.searchItems | **`userdirectory.searchItems `** **`rootId/rootDn=<>`** **`searchString=<> `** **`recursive=<>`** | This command performs a search on the user directory. This command is different from the other commands with these 3 parameters, which are optional. - **` rootDn or rootId`** — The FQDN/ ID can be taken from the database or the user interface. - **` searchString`** — String criteria of the search. It returns all items that contain the search string. - **` recursive`** — This is either "True" or "False". It defines if this search should be done recursively. It is default to be False if any parameter is not set. ### Note There are seven different scripts for the search item function. | :