JavaScript admin.appserverSetExternalSecurity

MarkLogic 12 EA 1 Product Documentation
admin:appserver-set-external-security

admin:appserver-set-external-security(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $external-security-names as xs:string*,
   $internal-security as xs:boolean,
   $authentication as xs:string
) as element(configuration)

Summary

This function sets the external security setting in the configuration for the specified App Server.

Parameters
config	A configuration specification, typically as returned from one of the Admin module functions.
appserver-id	The ID of the App Server. Typically, this is the result of an `admin:appserver-get-id` call.
external-security-names	The name of the External Security Config.
internal-security	A boolean value specifying whether the security database is used for authentication and authorization.
authentication	The authentication scheme (`basic`, `digest`, `digestbasic`, `application-level`, `kerberos-ticket`, or `certificate`).

Required Privileges

This operation requires at least one of the following privileges:

http://marklogic.com/xdmp/privileges/admin/app-server-security

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

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 $groupid := admin:group-get-id($config, "Default")
return admin:appserver-set-external-security($config,
           admin:appserver-get-id($config, $groupid, "myAppServer"),
           "my-ldap-config",fn:true(),"basic")

   => returns the new configuration element -- use admin:save-configuration
      to save the changes to the configuration or pass the configuration
      to other Admin API functions to make other changes.

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 $groupid := admin:group-get-id($config, "Default")
return admin:appserver-set-external-security($config,
           admin:appserver-get-id($config, $groupid, "myAppServer"),
           "my-kerberos-config",fn:false(),"kerberos-ticket")

   => returns the new configuration element -- use admin:save-configuration
      to save the changes to the configuration or pass the configuration
      to other Admin API functions to make other changes.

MarkLogic 12 EA 1 Product Documentationadmin:appserver-set-external-security

Summary

Required Privileges

Example

Example

MarkLogic 12 EA 1 Product Documentation
admin:appserver-set-external-security