Loading TOC...
JavaScript admin.groupSetXdqpSslMinAllowTls

MarkLogic 12 Product Documentation
admin:group-set-xdqp-ssl-min-allow-tls

admin:group-set-xdqp-ssl-min-allow-tls(
   $config as element(configuration),
   $group-id as xs:unsignedLong,
   $value as xs: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


  xquery version "1.0-ml";

  import module namespace admin = "http://marklogic.com/xdmp/admin"
      at "/MarkLogic/admin.xqy";

  let $config := admin:get-configuration()
  let $group := admin:group-get-id($config,"Default")

  return
        admin:group-set-xdqp-ssl-min-allow-tls($config, $group, "TLSv1.2")

  (: Set the minimum allow TLS protocol to "TLSv1.2" on the Default group. 
     Use admin:save-configuration to save the changes to the configuration or 
     pass the configuration to other Admin API functions to make other changes. :)

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