> For the complete documentation index, see [llms.txt](https://docs.tvheadend.org/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tvheadend.org/documentation/development/json-api/api-description/access.md). # Access Functions to list and manipulate access controls. ADMIN privilege is required to use these functions, except for access/whoami which requires Web Access privilege and access/entry/userlist which has no requirement. ### access/entry/class Lists the text strings, options and defaults used when configuring access controls within the TVH GUI (ie Configuration -> Users -> Access Entries). ### access/entry/create Creates a new user from a JSON object. * `conf` The JSON object describing the new user. ### access/entry/grid Lists users and their privileges. See [Common Parameters](/documentation/development/json-api/api-description/common-parameters.md) for details of selection parameters. ``` { "entries": [ { "uuid": "59c300295cbf01e53f096242fd5b8ffc", "index": 1, "enabled": true, "username": "*", "prefix": "192.168.1.0/24,127.0.0.1/32", "change": [ "change_rights", "change_chrange", "change_chtags", "change_dvr_configs", "change_profiles", "change_conn_limit", "change_lang", "change_lang_ui", "change_theme", "change_uilevel" ], "uilevel": -1, "uilevel_nochange": -1, "lang": "eng_GB", "langui": "eng_GB", "themeui": "blue", "streaming": [ "basic", "advanced", "htsp" ], "profile": [], "dvr": [ "basic", "htsp", "all", "all_rw", "failed" ], "htsp_anonymize": false, "dvr_config": [ "4e3a1e13acd2d5a9c129e7b00f6c986e" ], "webui": true, "admin": false, "conn_limit_type": 0, "conn_limit": 0, "channel_min": 0, "channel_max": 0, "channel_tag_exclude": false, "channel_tag": [], "comment": "Wildcard", "wizard": false }, ] } ``` ### access/entry/userlist Outputs a list of usernames. The "\*" user and any users with a zero-length name are excluded. The function is used internally to populate the "Owner" dropdown in Digital Video Recorder -> Finished Recordings -> Edit. It MUST be called by a user without ADMIN privileges, otherwise an empty list is returned. ``` { "entries" : [ { "key" : "myUserName", "val" : "myUserName" }, ... ] } ``` ### access/whoami Outputs a set of UI preferences for the calling user. Used by the Vue UI to improve performance. Available in Tvheadend 4.3-2740 and later. ``` { "uilevel": "expert", "uilevel_nochange": 1, "theme": "blue", "page_size": 999999999, "quicktips": 1, "chname_num": 0, "chname_src": 0, "date_mask": "", "label_formatting": 0, "default_tab": 0, "dvr_show_seconds": 0, "username": "myuser", "dvr": 1, "admin": 1, "time": 1785090579, "cookie_expires": 2047, "ticket_expires": 300, "info_area": "login,storage,time", "freediskspace": 56834629632, "useddiskspace": 2963262777, "totaldiskspace": 62777028608 } ``` ### ipblock/entry/class Lists the text strings, options and defaults used when configuring access controls within the TVH GUI (ie Configuration -> Users -> IP Blocking Records). ### ipblock/entry/create Creates a new IP-based access record. * `conf` The JSON object describing the access record. ### ipblock/entry/grid Lists IP-block records. See [Common Parameters](/documentation/development/json-api/api-description/common-parameters.md) for details of selection parameters. ``` { "entries" : [ { "prefix" : "10.0.0.0/8", "enabled" : true, "comment" : "Don't allow guests", "uuid" : "95a81ed085a1d1a9d8647400a878594d" } ], "total" : 1 } ``` ### passwd/entry/class Lists the text strings, options and defaults used when configuring access controls within the TVH GUI (ie Configuration -> Users -> Passwords). ### passwd/entry/create Creates a new password record. * `conf` The JSON object describing the record. ### passwd/entry/grid Lists passwords for users. Note that "password" is in clear-text while "password2" is base64-encoded with a static prefix. See [Common Parameters](/documentation/development/json-api/api-description/common-parameters.md) for details of selection parameters. ``` { "total" : 1, "entries" : [ { "password" : "XxXxXxXx", "uuid" : "2fa9ebf7e421a537ac032a6905134137", "username" : "xxxxxx", "enabled" : true, "wizard" : true, "password2" : "Base64EncodedPassword" }, ... ] } ``` If authentication for the user is by persistent token (requires TVHeadend > 4.3.1500) the entry has some extra fields: ``` { "total" : 1, "entries" : [ { "password" : "", "uuid" : "2fa9ebf7e421a537ac032a6905134137", "username" : "xxxxxx", "enabled" : true, "wizard" : true, "password2" : "Base64EncodedPassword" "auth": [ "enable" ], "authcode": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx" } ] } ``` --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.tvheadend.org/documentation/development/json-api/api-description/access.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.