adding security api reference opensearch-project#887 (opensearch-proj…

…ect#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]>
leanneeliatra · Jun 12, 2024 · 2c71a4d · 2c71a4d
1 parent 5ef5170
commit 2c71a4d
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/_api-reference/security-apis.md b/_api-reference/security-apis.md
@@ -0,0 +1,20 @@
+---
+layout: default
+title: Security APIs
+nav_order: 84
+---
+
+# Security APIs
+
+Security APIs provide information that can be very useful in troubleshooting connection and configuration issues.
+
+API | Method | Description
+:--- | :--- | :---
+`/_plugins/_security/whoami` | GET/POST | Returns basic details about the logged-in user.
+`/_opendistro/_security/sslinfo` | GET | Returns details about the SSL connection when using certificate authentication.
+`/_plugins/_security/api/permissionsinfo` | GET | Returns permission details for the logged-in user.
+`/_plugins/_security/authinfo` | GET/POST | Returns the backend roles and OpenSearch roles mapped to the logged-in user.
+`/_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.
+`/_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).
+`/_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).
+