MarkLogic 10 Product Documentation

sec.externalSecurityGetDescription

sec.externalSecurityGetDescription(
   external-security-name as String
) as 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.
const sec = require('/MarkLogic/security');

sec.externalSecurityGetDescription('ldapConfig');

// Returns the description set in the external authorization configuration 
// object, named 'ldapConfig'.