Skip to content

Commit 2c71a4d

Browse files
AntonEliatraNaarcha-AWSnatebower
authored
adding security api reference opensearch-project#887 (opensearch-project#7296)
* adding security api reference opensearch-project#887 Signed-off-by: AntonEliatra <[email protected]> * Update security-apis.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: AntonEliatra <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]>
1 parent 5ef5170 commit 2c71a4d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

_api-reference/security-apis.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
layout: default
3+
title: Security APIs
4+
nav_order: 84
5+
---
6+
7+
# Security APIs
8+
9+
Security APIs provide information that can be very useful in troubleshooting connection and configuration issues.
10+
11+
API | Method | Description
12+
:--- | :--- | :---
13+
`/_plugins/_security/whoami` | GET/POST | Returns basic details about the logged-in user.
14+
`/_opendistro/_security/sslinfo` | GET | Returns details about the SSL connection when using certificate authentication.
15+
`/_plugins/_security/api/permissionsinfo` | GET | Returns permission details for the logged-in user.
16+
`/_plugins/_security/authinfo` | GET/POST | Returns the backend roles and OpenSearch roles mapped to the logged-in user.
17+
`/_plugins/_security/api/ssl/certs` | GET | Displays the details and expiration dates of the certificates used on the OpenSearch HTTP and transport communication layers. Can only be called by users with the `superadmin` certificate.
18+
`/_plugins/_security/api/ssl/transport/reloadcerts` | PUT | Reloads the certificates on the `transport` layer. For more information, see [Reload TLS certificates on the transport layer]({{site.url}}{{site.baseurl}}/security/configuration/tls/#reload-tls-certificates-on-the-transport-layer).
19+
`/_plugins/_security/api/ssl/http/reloadcerts` | PUT | Reloads the certificates on the `http` layer. For more information, see [Reload TLS certificates on the http layer]({{site.url}}{{site.baseurl}}/security/configuration/tls/#reload-tls-certificates-on-the-http-layer).
20+

0 commit comments

Comments
 (0)