MarkLogic Server 11.0 Product Documentation

sec.ampAddRoles

sec.ampAddRoles(
   namespace as String,
   local-name as String,
   document-uri as String,
   database as (Number|String),
   role-names as String[]
) as null

Summary

Adds the roles ($role-names) to the list of roles granted to the amp ($namespace, $local-name, $document-uri).

Required Privileges

Usage Notes

If an amp with the given identifiers ($namespace, $local-name, $document-uri) is not found, an error is returned.

If one of $role-names does not correspond to an existing role, an error is returned.

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

This function must be executed against the security database.

Example

// execute this against the security database

declareUpdate();   
const sec = require('/MarkLogic/security.xqy');

sec.ampAddRoles(
    "http://marklogic.com/my_modules/myspace",
    "my-amp",
    "/MarkLogic/MyModule.xqy",
    0,
    "Contractor")

// Adds the "Contractor" role to the list of roles granted to the "my-amp" amp.