Loading TOC...

MarkLogic 9 Product Documentation
GET /manage/v2/credentials/secure

Summary

Retrieve secure credentials.

URL Parameters
format The format of the data in the response body. Allowed values: html, json or xml (default). Use this parameter to override the Accept header.
Request Headers
Accept The desired MIME type of the data in the response body. If the format parameter is present, it takes precedence over this header. Supported values: application/xml (default), application/json, text/html.
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

Upon success, MarkLogic server returns status code 200 (OK) and 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

This operation requires the security role.

Usage Notes

The structure of the output returned from this REST API 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 certificates.

This is a complex structure with the following children:

list-count

The number of users.

list-item

A certificate.

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.

Example


http://localhost:8002/manage/v2/credentials/secure

==>  Returns the secure credentials.

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