Loading TOC...

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. Currently, the only supported type is aws. 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 the manage-user role, or the following privilege:

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

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

Credentials

This is a complex structure with the following children:

storage-account

The Microsoft Azure storage account name.

storage-key

The Microsoft Azure storage access key.

Example


http://localhost:8002/manage/v2/credentials/properties?type=aws

==>  Returns credentials used to access Amazon Web Services (AWS). 
    

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

Comments

The commenting feature on this page is enabled by a third party. Comments posted to this page are publicly visible.