MarkLogic 9 Product Documentation
GET /manage/v2/security

Summary

Retrieve a summary of security information for the cluster.

URL Parameters
view	A specific view of the returned data. Allowed values: `default`.
format	The format of the returned data. Can be either `html`, `json`, or `xml` (default). This value overrides the Accept header if both are present. Value can be `xml`, `json` or `html`.

Request Headers
Accept	The expected MIME type of the request body. If the `format` parameter is present, it takes precedence over the Accept header.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response

A successful call to the endpoint will return the HTTP code 200 OK. This is the standard response for successful HTTP requests. The actual response will depend on the request method used.

Produces
application/xml	XML Content
application/json	JSON Content
text/html	HTML Web Content

Required Privileges

This operation requires the manage-admin role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Example

> curl -X GET --anyauth -u admin:admin 
            -H "Content-Type:application/xml"  http://localhost:8002/manage/v2/security

Output:

<?xml version="1.0" encoding="UTF-8"?>
<security-default-list xsi:schemaLocation="http://marklogic.com/manage/security manage-security.xsd" xmlns="http://marklogic.com/manage/security" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <meta>
    <uri>/manage/v2/security</uri>
    <current-time>2017-05-02T02:05:24.0916378-07:00</current-time>
    <elapsed-time units="sec">0.0117656</elapsed-time>
  </meta>
  <related-views>
    <related-view array="true">
      <view-type>item</view-type>
      <view-name>properties</view-name>
      <view-uri>security/properties</view-uri>
    </related-view>
  </related-views>
</security-default-list>

This is the XML output for GET.

Example

> curl -X GET --anyauth -u admin:admin 
            -H "Content-Type:application/json"  http://localhost:8002/manage/v2/security

Output:

	{
		"security-default-list":{
			"meta":{
				"uri":"/manage/v2/security",
				"current-time":"2017-05-02T02:05:24.0945418-07:00",
				"elapsed-time":{
					"units":"sec",
					"value":0.0111712}
				}
			,
			"related-views":{
				"related-view":{
					"view-type":"item",
					"view-name":"properties",
					"view-uri":"security/properties"}
				}
			}
		}

This is the JSON output for GET.

MarkLogic 9 Product DocumentationGET /manage/v2/security

Summary

Response

Required Privileges

Example

Example

MarkLogic 9 Product Documentation
GET /manage/v2/security