This resource address returns the specified external-security configuration.
For more information on external security, see
External Security in the Security Guide.
URL Parameters
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.
Request Headers
Accept
The expected MIME type of the response. 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
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 and
manage-admin roles.
Usage Notes
The structure of the output returned from
this REST API is as follows:
id
name
description
An object's description.
authentication
The authentication credentials to use.
This is a complex structure with the following children:
username
The username to use.
password
The password to use.
cache-timeout
An integer number of seconds, min 0, max 4294967295.
authorization
An authorization scheme.
ldap-server-uri
URI of the ldap server. Required if authentication or authorization is ldap.
ldap-base
starting point for search. Required if authentication or authorization is ldap.
ldap-attribute
ldap attribute for user lookup. Required if authentication or authorization is ldap.
ldap-default-user
ldap user used by MarkLogic server.
Required if authentication is kerberos and authorization is ldap or bind method is simple.
ldap-password
password of the default ldap user.
Required if authentication is kerberos and authorization is ldap or bind method is simple.
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.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
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/MyExternalName
==> Returns the configuration of the external-security, "MyExternalName,"
in the Security database.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.