MarkLogic 12 Product Documentation
admin.groupSetXdqpSslMinAllowTls

admin.groupSetXdqpSslMinAllowTls(
   config as element(configuration),
   group-id as (Number|String),
   value as String
) as element(configuration)

Summary

This function set the minimum allow TLS protocol for XDQP in the specified group. If it is set to "TLSv1.2", both TLS 1.2 and TLS 1.3 can be used. If it is set to "TLSv1.3", only TLS 1.3 can be used. The default is "TLSv1.2".

Parameters
config A configuration specification, typically as returned from one of the Admin module functions.
group-id The name of the group.
value The minimum allow TLS protocol: "TLSv1.2" or "TLSv1.3".

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/group-security

http://marklogic.com/xdmp/privileges/admin/group-security/{id}

Example

  
  const admin = require('/MarkLogic/admin.xqy');
  const config = admin.getConfiguration()
  const group = admin.groupGetId(config,"Default")
        admin.groupSetXdqpSslMinAllowTls(config, group, "TLSv1.2")

   //Set the minimum allow TLS protocol to "TLSv1.2" on the Default group. 
   //Use admin.saveConfiguration to save the changes to the configuration or 
   //pass the configuration to other Admin API functions to make other changes. 
    
Powered by MarkLogic Server | Terms of Use | Privacy Policy