Changes

All functions in this module and errors are assigned to the {{Code|<code><nowiki>http://basex.org/modules/user}} </nowiki></code> namespace, which is statically bound to the {{Code|user}} prefix.<br/>

=FunctionsRead Operations= ==user:current== {| width='100%'|-| width='120' | '''Signatures'''|{{Func|user:current||xs:string}}<br/>|-| '''Summary'''|Returns the name of the currently logged in user.|-| '''Examples'''|* If the GUI or the standalone mode is used, {{Code|user:current()}} always returns {{Code|admin}}.|}

|Returns the names of all registered usersthat are visible to the current user.

* After a fresh installation, {{Code|user:list()}} returns all registered userswill only return {{Code|admin}}.

|{{Func|user:list-details||element(user)*}}<br/>{{Func|user:list-details|$name as xs:string|element(user)*}}<br/>

|Returns an element sequence, containing all registered users and their permissionsthat are visible to the current user.<br/>In addition to the [[Commands#SHOW_USERS|SHOW USERS]]command, encoded password strings and database permissions will be output. A user {{Code|$name}} can be specified to filter the results in advance.

* By defaultAfter a fresh installation, {{Code|user:list-details()}} returns output similar to the following outputone:

|{{Func|user:create|$name as xs:string, $password as xs:string|empty-sequence()}}<br/>{{Func|user:create|$name as xs:string, $password as xs:string, $permission permissions as xs:string*|empty-sequence()}}<br/>{{Func|user:create|$name as xs:string, $password as xs:string, $permissions as xs:string*, $patterns as xs:string*|empty-sequence()}}

|Creates a new user with the specified {{Code|$name}} and , {{Code|$password}}. The default permission , and {{Code|none$permissions}} can be overwritten . Local permissions are granted with the non-empty glob {{Code|$permissionpatterns}} . The default global permission (''none'') can be overwritten with an empty pattern or by omitting the last argument. Existing users will be overwritten.

|{{Func|user:grant|$name as xs:string, $permission permissions as xs:string*|empty-sequence()}}<br/>{{Func|user:grant|$name as xs:string, $permission permissions as xs:string*, $pattern patterns as xs:string*|empty-sequence()}}

|Grants the specified global or local {{Code|$permissionpermissions}} to a user with the specified {{Code|$name}}. If a Local permissions are granted with non-empty glob {{Code|$patternpatterns}} is specified, the permission will only be applied to databases matching that pattern.

* {{Code|user:grant('John', ('read', 'write'), ('index*', 'unit*'))}} allows John to read all databases starting with the letters 'index', and to write to all databases starting with the letters 'unit'.

|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|permission|#Errors}} The specified permission is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|local|#Errors}} A local permission can only be 'none', 'read' or 'write'.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.

|{{Func|user:drop|$name as xs:string|empty-sequence()}}<br/>{{Func|user:drop|$name as xs:string, $pattern patterns as xs:string*|empty-sequence()}}

|Drops a user with the specified {{Code|$name}}. If a non-empty glob {{Code|$patternpatterns}} is are specified, only the database pattern patterns will be dropped.

|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|pattern|#Errors}} The specified database pattern is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.

|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|admin|#Errors}} The "admin" user cannot be modified.<br/>{{Error|logged-in|#Errors}} The specified user is currently logged in.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.<br/>{{Error|conflict|#Errors}} A user cannot be both altered and dropped.

|{{Error|unknown|#Errors}} The specified user name is unknown.<br/>{{Error|name|#Errors}} The specified user name is invalid.<br/>{{Error|update|#Errors}} The operation can only be performed once per user or database pattern.|} ==user:update-info== {{Mark|Introduced with Version 8.6}}: {| width='100%'|-| width='120' | '''Signatures'''|{{Func|user:update-info|$info as element(info)|empty-sequence()}}|-| '''Summary'''|Updates the <code>info</code> element with {{Code|$info}}. This node can be used to organize application-specific data (groups, enhanced user info, etc.).|-| '''Examples'''|* Store initial groups information:<pre class="brush:xquery">user:update-info(element info { for $group in ('editor', 'author', 'writer') return element group { $group }})</pre>* Assign a group to a new user:<pre class="brush:xquery">let $user := 'john', $pw := '8hKJ@%.c/!0O', $group := 'editor'return ( user:create($user, $pw), user:update-info(user:info() update insert node <user name='{ $user }' group='{ $group }'/> into . ))</pre>