OpenSearch · Schema
OpenSearch Security Role
Schema describing an OpenSearch Security plugin role definition.
SearchAnalyticsObservabilityOpen-SourceSecurity
Properties
| Name | Type | Description |
|---|---|---|
| cluster_permissions | array | Cluster-level permissions or action group references. |
| index_permissions | array | |
| tenant_permissions | array | |
| description | string | |
| reserved | boolean | |
| hidden | boolean | |
| static | boolean |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json",
"title": "OpenSearch Security Role",
"description": "Schema describing an OpenSearch Security plugin role definition.",
"type": "object",
"properties": {
"cluster_permissions": {
"type": "array",
"items": { "type": "string" },
"description": "Cluster-level permissions or action group references."
},
"index_permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"index_patterns": {
"type": "array",
"items": { "type": "string" }
},
"dls": {
"type": "string",
"description": "Document-level security query."
},
"fls": {
"type": "array",
"items": { "type": "string" },
"description": "Field-level security inclusions or exclusions."
},
"masked_fields": {
"type": "array",
"items": { "type": "string" }
},
"allowed_actions": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["index_patterns", "allowed_actions"]
}
},
"tenant_permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant_patterns": {
"type": "array",
"items": { "type": "string" }
},
"allowed_actions": {
"type": "array",
"items": { "type": "string" }
}
},
"required": ["tenant_patterns", "allowed_actions"]
}
},
"description": { "type": "string" },
"reserved": { "type": "boolean" },
"hidden": { "type": "boolean" },
"static": { "type": "boolean" }
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/opensearch-role"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.