MarkLogic 9 Product Documentation
sec.createUser

sec.createUser(
   user-name as String,
   description as String?,
   password as String,
   role-names as String[],
   permissions as element(sec.permission)[],
   collections as String[],
   [external-names as String[]]
) as (Number|String)

Summary

Creates a new user in the system database for the context database. Returns the user ID of the created user.

Parameters
user-name	A unique username. If $user-name is not unique, an error is returned.
description	A description of the user.
password	The initial password for this user.
role-names	The roles (if any) assigned to this user. If one of the $role-names names a role that does not exist, an error is returned.
permissions	The default permissions granted to this user.
collections	The URIs for the default collections to which this user has access.
external-names	One or more external names used to match the user with one or more Distinguished Names in an LDAP server or User Principals in a Kerberos server.

Required Privileges

http://marklogic.com/xdmp/privileges/create-user
and, for role assignment:
http://marklogic.com/xdmp/privileges/grant-all-roles or
http://marklogic.com/xdmp/privileges/grant-my-roles

Usage Notes

This function must be executed against the security database.

Example


// execute this against the security database

declareUpdate();   
const sec = require('/MarkLogic/security.xqy');

sec.createUser(
    "Jim",
    "Jim the temp",
    "newtemp",
    "Temporary",
    [xdmp.permission("security", "read","element")]
    ["http://marklogic.com/dev_modules"])
 
 // Creates a new user, named "Jim," with the role, "Temporary."  "Jim" 
    is assigned the default permission, security(read), and the default 
    collection, "http://marklogic.com/dev_modules".

MarkLogic 9 Product Documentationsec.createUser

Summary

Required Privileges

Usage Notes

Example

MarkLogic 9 Product Documentation
sec.createUser