MarkLogic 12 Product Documentation

GET /manage/v2/external-security

Summary

This resource address returns a summary of the external-security configurations in the security database.

For more information on external security, see External Security in the Security Guide.

Response

Upon success, MarkLogic Server returns status code 200 (OK). The response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

• the manage-admin and security role
• the following privileges:

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

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

  http://marklogic.com/xdmp/privileges/external-security-get-authentication

Usage Notes

The structure of the data in the response for the default view is as follows:

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type

The kind of error.

error-name

The name of the error.

error-code

The error identifier.

error-message

The error text.

list-items

The list of amps.

This is a complex structure with the following children:

list-count

The number of certificates.

list-item

An amp.

This is a complex structure with the following children:

uriref

The path for a resource or list of resources.

idref

The numeric identifier for the resource.

nameref

The name of the resource.

namespace

A namespace.

document-uri

A document's URI.

modules-database

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type

The kind of view.

view-name

The name of the view.

view-uri

The path for the view.

Example

  http://localhost:8002/manage/v2/external-security

  ==>  Returns a list of the external-security configurations 
       in the Security database.