MarkLogic 10 Product Documentation

sec.createPrivilege

sec.createPrivilege(
   privilege-name as String,
   action as String,
   kind as String,
   role-names as String[]
) as (Number|String)

Summary

Creates a new privilege and returns the new privilege-id.

For execute privileges, the privilege is initially nothing more than a name. Use the xdmp:security-assert() function in your code to associate the privilege with a protected operation.

For URI privileges, the $action parameter identifies the base URI to be protected. Users must have this privilege to access any of the documents or code under the specified URI.

If $action is not unique, an error is returned.

If $kind is not one of ("execute", "uri") then en error is returned.

If one of the $role-names names a role that does not exist, an error is returned.

If the current user is limited to granting only his/her roles, and $role-names is not a subset of the current user's roles, then an error is returned.

Required Privileges

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.createPrivilege("mypriv", 
                     "http://marklogic.com/xdmp/privileges/mypriv", 
                     "execute", 
                     "Developer")

// Creates an execute privilege, named "mypriv," and assigns it to the
   "Developer" role.