Loading TOC...

sec.createAmp

sec.createAmp(
   $namespace as String,
   $local-name as String,
   $document-uri as String,
   $database as xs.anyAtomicType,
   $role-names as String[]
) as (Number|String)

Summary

Creates a new amp in the system database for the context database.

If the tuple ($namespace, $local-name, $document-uri, $database) is not unique, an error is returned.

If one of the $role-names does not identify a role, 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.

Returns the amp-id.

Parameters
$namespace Namespace of the function to which the amp applies.
$local-name Name of function to which the amp applies.
$document-uri URI of the module in which the function is located.
$database The Database ID or name in which the module is located. If the module is on the filesystem (in the Modules directory), specify xs:unsignedLong(0).
$role-names Roles that should be temporarily assumed while the amp is in effect.

Required Privileges

http://marklogic.com/xdmp/privileges/create-amp
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.createAmp(
    "http://marklogic.com/my_modules/myspace",
    "my-amp",
    "/MarkLogic/MyModule.xqy",
    0,
    "Developer")
    
 // Creates an amp for the function "my-amp" in the MyModule.xqy module that
    temporarily grants users the "Developer" role. 

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.