Loading TOC...
JavaScript admin.appserverSetAPITokenAuthentication

MarkLogic 12 Product Documentation
admin:appserver-set-API-token-authentication

admin:appserver-set-API-token-authentication(
   $config as element(configuration),
   $appserver-id as xs:unsignedLong,
   $value as xs:string
) as element(configuration)

Summary

This function sets the API token authentication option for the specified App Server. When set as true, the App Server will accept MarkLogic issued API tokens to perform related task. For example, this option must be turned on on a Join Host of a dynamic host join process. So a dynamic host can communicate with a Join Host to join the cluster.

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.
value When setting as true, the app server will be able to check if a token is a valid MarkLogic issued API tokens. When setting as false, the app server will reject all MarkLogic issued API tokens.

Required Privileges

This operation requires at least one of the following privileges:

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

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

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

http://marklogic.com/xdmp/privileges/admin/group/{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 $appserver-id := admin:appserver-get-id($config, admin:group-get-id($config, "Default"), "Admin")
  return admin:appserver-set-API-token-authentication($config,  $appserver-id, fn:true())
  (: 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.  :)

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