MarkLogic Server 11.0 Product Documentation
GET /manage/v2/credentials/properties

Summary

Retrieve credentials used to access external services, such as Amazon Web Services (AWS). If no credentials have been set, only the typeproperty is returned.

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.
type	The type of credentials to be returned. If not specified, the default is `aws`.

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 one of the following:

the manage-admin and security role
the following privileges:
http://marklogic.com/xdmp/privileges/manage

http://marklogic.com/xdmp/privileges/manage-admin
and/or
http://marklogic.com/xdmp/privileges/credentials-get-aws

http://marklogic.com/xdmp/privileges/credentials-get-azure

Usage Notes

The structure of the output returned from this REST API is as follows:

aws

Credentials

This is a complex structure with the following children:

access-key: The Amazon Web Services access key.
secret-key: The Amazon Web Services secret key.
session-token: The Amazon Web Services session token.

azure