MarkLogic 12 Product Documentation

sec:external-security-get-description

sec:external-security-get-description(
   $external-security-name as xs:string
) as xs:string

Summary

This function returns the description set in the named external authorization configuration object. You must have the xdmp/privileges/external-security-get-description privilege to execute this function.

Required Privileges

Usage Notes

This function must be executed against the security database.

Example

(: execute this against the security database :)
xquery version "1.0-ml"; 
 
import module namespace sec = "http://marklogic.com/xdmp/security" 
      at "/MarkLogic/security.xqy";

sec:external-security-get-description("ldapconfig")

(: Returns the description set in the external authorization configuration 
   object, named "ldapconfig". :)