OpenSearch Security Plugin REST API
The OpenSearch Security plugin REST API lets administrators programmatically create and manage internal users, roles, role mappings, action groups, tenants, security configuration, audit log configuration, certificates, cache, allowlists, distinguished node names, and inspect the running security configuration. Endpoints are exposed under /_plugins/_security/api on the OpenSearch cluster.
What You Can Do
MCP Tools
getaccount
Get current user account
changepassword
Change current user password
listinternalusers
List all internal users
getinternaluser
Get internal user
createorreplaceinternaluser
Create or replace an internal user
deleteinternaluser
Delete internal user
patchinternaluser
Patch internal user
listroles
List all roles
getrole
Get role
createorreplacerole
Create or replace a role
deleterole
Delete role
patchrole
Patch role
listrolemappings
List all role mappings
getrolemapping
Get role mapping
createorreplacerolemapping
Create or replace a role mapping
deleterolemapping
Delete role mapping
patchrolemapping
Patch role mapping
listactiongroups
List all action groups
getactiongroup
Get action group
createorreplaceactiongroup
Create or replace an action group
deleteactiongroup
Delete action group
patchactiongroup
Patch action group
listtenants
List all tenants
gettenant
Get tenant
createorreplacetenant
Create or replace a tenant
deletetenant
Delete tenant
patchtenant
Patch tenant
getsecurityconfig
Get security configuration
patchsecurityconfig
Patch security configuration
replacesecurityconfig
Replace security configuration
getauditconfig
Get audit log configuration
replaceauditconfig
Replace audit log configuration
patchauditconfig
Patch audit log configuration
getallowlist
Get allowlist
replaceallowlist
Replace allowlist
patchallowlist
Patch allowlist
listnodesdn
List all node DN entries
getnodesdn
Get node DN entry
createorreplacenodesdn
Create or replace node DN entry
deletenodesdn
Delete node DN entry
getcertificates
Get SSL certificates loaded by the cluster
reloadtransportcerts
Reload transport-layer SSL certificates
reloadhttpcerts
Reload HTTP-layer SSL certificates
flushsecuritycache
Flush security cache
securityhealth
Security plugin health
authinfo
Get authentication info for current request
sslinfo
Get SSL handshake info for current request