@elastic/schemas 0.5.1 → 0.6.0

package/lib/es/json/security.bulk_update_api_keys.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_update_api_keys", "description": "Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.", "x-api": { "id": "security.bulk_update_api_keys", "name": "bulk-update-api-keys", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/_bulk_update", "x-urls": [{ "path": "/_security/api_key/_bulk_update", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.5.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.", "x-found-in": "body" }, "ids": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The API key identifiers.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.", "x-found-in": "body" }, "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.", "x-found-in": "body" } }, "required": ["ids"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.bulk_update_api_keys", "description": "Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.", "x-api": { "id": "security.bulk_update_api_keys", "name": "bulk-update-api-keys", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/_bulk_update", "x-urls": [{ "path": "/_security/api_key/_bulk_update", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.5.0", "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.", "x-found-in": "body" }, "ids": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "The API key identifiers.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.", "x-found-in": "body" }, "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["ids"] }

package/lib/es/json/security.change_password.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.change_password", "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "x-api": { "id": "security.change_password", "name": "change-password", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_password", "x-urls": [{ "path": "/_security/user/{username}/_password", "methods": ["PUT", "POST"] }, { "path": "/_security/user/_password", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "password": { "type": "string", "description": "The new password value. Passwords must be at least 6 characters long.", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", "x-found-in": "body" }, "username": { "type": "string", "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.change_password", "description": "Change passwords.\n\nChange the passwords of users in the native realm and built-in users.", "x-api": { "id": "security.change_password", "name": "change-password", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_password", "x-urls": [{ "path": "/_security/user/{username}/_password", "methods": ["PUT", "POST"] }, { "path": "/_security/user/_password", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "password": { "type": "string", "description": "The new password value. Passwords must be at least 6 characters long.", "x-found-in": "body" }, "password_hash": { "type": "string", "description": "A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.", "x-found-in": "body" }, "username": { "type": "string", "description": "The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.clear_api_key_cache.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_api_key_cache", "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "x-api": { "id": "security.clear_api_key_cache", "name": "clear-api-key-cache", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/{ids}/_clear_cache", "x-urls": [{ "path": "/_security/api_key/{ids}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["ids"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_api_key_cache", "description": "Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.", "x-api": { "id": "security.clear_api_key_cache", "name": "clear-api-key-cache", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/{ids}/_clear_cache", "x-urls": [{ "path": "/_security/api_key/{ids}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.10.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "ids": { "$ref": "./_types.json#/$defs/_types__Ids", "description": "Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["ids"] }

package/lib/es/json/security.clear_cached_privileges.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_privileges", "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "x-api": { "id": "security.clear_cached_privileges", "name": "clear-cached-privileges", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/privilege/{application}/_clear_cache", "x-urls": [{ "path": "/_security/privilege/{application}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "application": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["application"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_privileges", "description": "Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.", "x-api": { "id": "security.clear_cached_privileges", "name": "clear-cached-privileges", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/privilege/{application}/_clear_cache", "x-urls": [{ "path": "/_security/privilege/{application}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "application": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["application"] }

package/lib/es/json/security.clear_cached_realms.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_realms", "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", "x-api": { "id": "security.clear_cached_realms", "name": "clear-cached-realms", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/realm/{realms}/_clear_cache", "x-urls": [{ "path": "/_security/realm/{realms}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "usernames": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.", "x-found-in": "query" }, "realms": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["realms"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_realms", "description": "Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.", "x-api": { "id": "security.clear_cached_realms", "name": "clear-cached-realms", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/realm/{realms}/_clear_cache", "x-urls": [{ "path": "/_security/realm/{realms}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "usernames": { "type": "array", "items": { "type": "string" }, "description": "A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.", "x-found-in": "query" }, "realms": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["realms"] }

package/lib/es/json/security.clear_cached_roles.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_roles", "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "x-api": { "id": "security.clear_cached_roles", "name": "clear-cached-roles", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/role/{name}/_clear_cache", "x-urls": [{ "path": "/_security/role/{name}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_roles", "description": "Clear the roles cache.\n\nEvict roles from the native role cache.", "x-api": { "id": "security.clear_cached_roles", "name": "clear-cached-roles", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/role/{name}/_clear_cache", "x-urls": [{ "path": "/_security/role/{name}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

package/lib/es/json/security.clear_cached_service_tokens.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_service_tokens", "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", "x-api": { "id": "security.clear_cached_service_tokens", "name": "clear-cached-service-tokens", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The name of the service, which must be unique within its namespace.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.", "x-found-in": "path" } }, "required": ["namespace", "service", "name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clear_cached_service_tokens", "description": "Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.", "x-api": { "id": "security.clear_cached_service_tokens", "name": "clear-cached-service-tokens", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The name of the service, which must be unique within its namespace.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["namespace", "service", "name"] }

package/lib/es/json/security.clone_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clone_api_key", "description": "Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported.", "x-api": { "id": "security.clone_api_key", "name": "clone-api-key", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/clone", "x-urls": [{ "path": "/_security/api_key/clone", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "api_key": { "type": "string", "description": "The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the cloned API key.\nIf not provided, the name of the source key is used.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" } }, "required": ["api_key"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.clone_api_key", "description": "Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported.", "x-api": { "id": "security.clone_api_key", "name": "clone-api-key", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/api_key/clone", "x-urls": [{ "path": "/_security/api_key/clone", "methods": ["POST", "PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "9.4.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "api_key": { "type": "string", "description": "The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the cloned API key.\nIf not provided, the name of the source key is used.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["api_key"] }

package/lib/es/json/security.create_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_api_key", "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "x-api": { "id": "security.create_api_key", "name": "create-api-key", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/api_key", "x-urls": [{ "path": "/_security/api_key", "methods": ["PUT", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the API key.", "x-found-in": "body" }, "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body", "x-availability": { "stack": { "since": "7.13.0" }, "serverless": {} } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_api_key", "description": "Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.", "x-api": { "id": "security.create_api_key", "name": "create-api-key", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/api_key", "x-urls": [{ "path": "/_security/api_key", "methods": ["PUT", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The expiration time for the API key.\nBy default, API keys never expire.", "x-found-in": "body" }, "name": { "type": "string", "description": "A name for the API key.", "x-found-in": "body" }, "role_descriptors": { "type": "object", "additionalProperties": { "$ref": "./security._types.json#/$defs/security._types__RoleDescriptor" }, "description": "An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body", "x-availability": { "stack": { "since": "7.13.0" }, "serverless": {} } }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.create_cross_cluster_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_cross_cluster_api_key", "description": "Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", "x-api": { "id": "security.create_cross_cluster_api_key", "name": "create-cross-cluster-api-key", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/cross_cluster/api_key", "x-urls": [{ "path": "/_security/cross_cluster/api_key", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "access": { "$ref": "./security._types.json#/$defs/security._types__Access", "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Expiration time for the API key.\nBy default, API keys never expire.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "name": { "type": "string", "description": "Specifies the name for this API key.", "x-found-in": "body" }, "certificate_identity": { "type": "string", "description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.", "x-found-in": "body" } }, "required": ["access", "name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_cross_cluster_api_key", "description": "Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.", "x-api": { "id": "security.create_cross_cluster_api_key", "name": "create-cross-cluster-api-key", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/cross_cluster/api_key", "x-urls": [{ "path": "/_security/cross_cluster/api_key", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "access": { "$ref": "./security._types.json#/$defs/security._types__Access", "description": "The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.", "x-found-in": "body" }, "expiration": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Expiration time for the API key.\nBy default, API keys never expire.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.", "x-found-in": "body" }, "name": { "type": "string", "description": "Specifies the name for this API key.", "x-found-in": "body" }, "certificate_identity": { "type": "string", "description": "The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["access", "name"] }

package/lib/es/json/security.create_service_token.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_service_token", "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.\n\nIMPORTANT: On Serverless, non-operator users can create tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nCreating tokens for any other service account requires operator privileges.", "x-api": { "id": "security.create_service_token", "name": "create-service-token", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}", "methods": ["PUT", "POST"] }, { "path": "/_security/service/{namespace}/{service}/credential/token", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "namespace": { "type": "string", "description": "The name of the namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The name of the service.", "x-found-in": "path" }, "name": { "type": "string", "description": "The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.", "x-found-in": "path" } }, "required": ["namespace", "service"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.create_service_token", "description": "Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.\n\nIMPORTANT: On Serverless, non-operator users can create tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nCreating tokens for any other service account requires operator privileges.", "x-api": { "id": "security.create_service_token", "name": "create-service-token", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}", "methods": ["PUT", "POST"] }, { "path": "/_security/service/{namespace}/{service}/credential/token", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "namespace": { "type": "string", "description": "The name of the namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The name of the service.", "x-found-in": "path" }, "name": { "type": "string", "description": "The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["namespace", "service"] }

package/lib/es/json/security.delegate_pki.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delegate_pki", "description": "Delegate PKI authentication.\n\nThis API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", "x-api": { "id": "security.delegate_pki", "name": "delegate-pki", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/delegate_pki", "x-urls": [{ "path": "/_security/delegate_pki", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.4.0", "stability": "stable" } }, "type": "object", "properties": { "x509_certificate_chain": { "type": "array", "items": { "type": "string" }, "description": "The X509Certificate chain, which is represented as an ordered string array.\nEach string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding.\n\nThe first element is the target certificate that contains the subject distinguished name that is requesting access.\nThis may be followed by additional certificates; each subsequent certificate is used to certify the previous one.", "x-found-in": "body" } }, "required": ["x509_certificate_chain"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delegate_pki", "description": "Delegate PKI authentication.\n\nThis API implements the exchange of an X509Certificate chain for an Elasticsearch access token.\nThe certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`.\nA successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm.\n\nThis API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch.\n\nIMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.\nThis is part of the TLS authentication process and it is delegated to the proxy that calls this API.\nThe proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.", "x-api": { "id": "security.delegate_pki", "name": "delegate-pki", "namespace": "security" }, "x-method": "POST", "x-path": "/_security/delegate_pki", "x-urls": [{ "path": "/_security/delegate_pki", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.4.0", "stability": "stable" } }, "type": "object", "properties": { "x509_certificate_chain": { "type": "array", "items": { "type": "string" }, "description": "The X509Certificate chain, which is represented as an ordered string array.\nEach string in the array is a base64-encoded (Section 4 of RFC4648 - not base64url-encoded) of the certificate's DER encoding.\n\nThe first element is the target certificate that contains the subject distinguished name that is requesting access.\nThis may be followed by additional certificates; each subsequent certificate is used to certify the previous one.", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["x509_certificate_chain"] }

package/lib/es/json/security.delete_privileges.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_privileges", "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "x-api": { "id": "security.delete_privileges", "name": "delete-privileges", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/privilege/{application}/{name}", "x-urls": [{ "path": "/_security/privilege/{application}/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "application": { "type": "string", "description": "The name of the application.\nApplication privileges are always associated with exactly one application.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the privilege.", "x-found-in": "path" } }, "required": ["application", "name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_privileges", "description": "Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "x-api": { "id": "security.delete_privileges", "name": "delete-privileges", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/privilege/{application}/{name}", "x-urls": [{ "path": "/_security/privilege/{application}/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "6.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "application": { "type": "string", "description": "The name of the application.\nApplication privileges are always associated with exactly one application.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the privilege.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["application", "name"] }

package/lib/es/json/security.delete_role.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_role", "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", "x-api": { "id": "security.delete_role", "name": "delete-role", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/role/{name}", "x-urls": [{ "path": "/_security/role/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the role.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_role", "description": "Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files.", "x-api": { "id": "security.delete_role", "name": "delete-role", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/role/{name}", "x-urls": [{ "path": "/_security/role/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the role.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

package/lib/es/json/security.delete_role_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_role_mapping", "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", "x-api": { "id": "security.delete_role_mapping", "name": "delete-role-mapping", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/role_mapping/{name}", "x-urls": [{ "path": "/_security/role_mapping/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "name": { "type": "string", "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", "x-found-in": "path" } }, "required": ["name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_role_mapping", "description": "Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files.", "x-api": { "id": "security.delete_role_mapping", "name": "delete-role-mapping", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/role_mapping/{name}", "x-urls": [{ "path": "/_security/role_mapping/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "name": { "type": "string", "description": "The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["name"] }

package/lib/es/json/security.delete_service_token.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_service_token", "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.\n\nIMPORTANT: On Serverless, non-operator users can delete tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nDeleting tokens for any other service account requires operator privileges.", "x-api": { "id": "security.delete_service_token", "name": "delete-service-token", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "namespace": { "type": "string", "description": "The namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.", "x-found-in": "path" }, "name": { "type": "string", "description": "The name of the service account token.", "x-found-in": "path" } }, "required": ["namespace", "service", "name"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_service_token", "description": "Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.\n\nIMPORTANT: On Serverless, non-operator users can delete tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nDeleting tokens for any other service account requires operator privileges.", "x-api": { "id": "security.delete_service_token", "name": "delete-service-token", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/service/{namespace}/{service}/credential/token/{name}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential/token/{name}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "namespace": { "type": "string", "description": "The namespace, which is a top-level grouping of service accounts.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.", "x-found-in": "path" }, "name": { "type": "string", "description": "The name of the service account token.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["namespace", "service", "name"] }

package/lib/es/json/security.delete_user.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_user", "description": "Delete users.\n\nDelete users from the native realm.", "x-api": { "id": "security.delete_user", "name": "delete-user", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/user/{username}", "x-urls": [{ "path": "/_security/user/{username}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" } }, "required": ["username"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.delete_user", "description": "Delete users.\n\nDelete users from the native realm.", "x-api": { "id": "security.delete_user", "name": "delete-user", "namespace": "security" }, "x-method": "DELETE", "x-path": "/_security/user/{username}", "x-urls": [{ "path": "/_security/user/{username}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["username"] }

package/lib/es/json/security.disable_user.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.disable_user", "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", "x-api": { "id": "security.disable_user", "name": "disable-user", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_disable", "x-urls": [{ "path": "/_security/user/{username}/_disable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" } }, "required": ["username"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.disable_user", "description": "Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch.", "x-api": { "id": "security.disable_user", "name": "disable-user", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_disable", "x-urls": [{ "path": "/_security/user/{username}/_disable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["username"] }

package/lib/es/json/security.disable_user_profile.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.disable_user_profile", "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", "x-api": { "id": "security.disable_user_profile", "name": "disable-user-profile", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/profile/{uid}/_disable", "x-urls": [{ "path": "/_security/profile/{uid}/_disable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.", "x-found-in": "query" }, "uid": { "type": "string", "description": "Unique identifier for the user profile.", "x-found-in": "path" } }, "required": ["uid"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.disable_user_profile", "description": "Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API .", "x-api": { "id": "security.disable_user_profile", "name": "disable-user-profile", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/profile/{uid}/_disable", "x-urls": [{ "path": "/_security/profile/{uid}/_disable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.", "x-found-in": "query" }, "uid": { "type": "string", "description": "Unique identifier for the user profile.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["uid"] }

package/lib/es/json/security.enable_user.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enable_user", "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", "x-api": { "id": "security.enable_user", "name": "enable-user", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_enable", "x-urls": [{ "path": "/_security/user/{username}/_enable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" } }, "required": ["username"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enable_user", "description": "Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled.", "x-api": { "id": "security.enable_user", "name": "enable-user", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/user/{username}/_enable", "x-urls": [{ "path": "/_security/user/{username}/_enable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "stable" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.", "x-found-in": "query" }, "username": { "type": "string", "description": "An identifier for the user.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["username"] }

package/lib/es/json/security.enable_user_profile.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enable_user_profile", "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", "x-api": { "id": "security.enable_user_profile", "name": "enable-user-profile", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/profile/{uid}/_enable", "x-urls": [{ "path": "/_security/profile/{uid}/_enable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", "x-found-in": "query" }, "uid": { "type": "string", "description": "A unique identifier for the user profile.", "x-found-in": "path" } }, "required": ["uid"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enable_user_profile", "description": "Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.", "x-api": { "id": "security.enable_user_profile", "name": "enable-user-profile", "namespace": "security" }, "x-method": "PUT", "x-path": "/_security/profile/{uid}/_enable", "x-urls": [{ "path": "/_security/profile/{uid}/_enable", "methods": ["PUT", "POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.", "x-found-in": "query" }, "uid": { "type": "string", "description": "A unique identifier for the user profile.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["uid"] }

package/lib/es/json/security.enroll_kibana.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enroll_kibana", "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", "x-api": { "id": "security.enroll_kibana", "name": "enroll-kibana", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/enroll/kibana", "x-urls": [{ "path": "/_security/enroll/kibana", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enroll_kibana", "description": "Enroll Kibana.\n\nEnable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.\n\nNOTE: This API is currently intended for internal use only by Kibana.\nKibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.", "x-api": { "id": "security.enroll_kibana", "name": "enroll-kibana", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/enroll/kibana", "x-urls": [{ "path": "/_security/enroll/kibana", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.enroll_node.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enroll_node", "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.", "x-api": { "id": "security.enroll_node", "name": "enroll-node", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/enroll/node", "x-urls": [{ "path": "/_security/enroll/node", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.enroll_node", "description": "Enroll a node.\n\nEnroll a new node to allow it to join an existing cluster with security features enabled.\n\nThe response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.\nThe response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.", "x-api": { "id": "security.enroll_node", "name": "enroll-node", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/enroll/node", "x-urls": [{ "path": "/_security/enroll/node", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.0.0", "stability": "stable" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_api_key.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_api_key", "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "x-api": { "id": "security.get_api_key", "name": "get-api-key", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/api_key", "x-urls": [{ "path": "/_security/api_key", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "An API key id.\nThis parameter cannot be used with any of `name`, `realm_name` or `username`.", "x-found-in": "query" }, "name": { "type": "string", "description": "An API key name.\nThis parameter cannot be used with any of `id`, `realm_name` or `username`.\nIt supports prefix search with wildcard.", "x-found-in": "query" }, "owner": { "type": "boolean", "description": "A boolean flag that can be used to query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.", "x-found-in": "query" }, "realm_name": { "type": "string", "description": "The name of an authentication realm.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", "x-found-in": "query" }, "username": { "type": "string", "description": "The username of a user.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", "x-found-in": "query" }, "with_limited_by": { "type": "boolean", "description": "Return the snapshot of the owner user's role descriptors\nassociated with the API key. An API key's actual\npermission is the intersection of its assigned role\ndescriptors and the owner user's role descriptors.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.5.0" }, "serverless": {} } }, "active_only": { "type": "boolean", "description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.10.0" }, "serverless": {} } }, "with_profile_uid": { "type": "boolean", "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.14.0" }, "serverless": {} } } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_api_key", "description": "Get API key information.\n\nRetrieves information for one or more API keys.\nNOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.\nIf you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.", "x-api": { "id": "security.get_api_key", "name": "get-api-key", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/api_key", "x-urls": [{ "path": "/_security/api_key", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.7.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "An API key id.\nThis parameter cannot be used with any of `name`, `realm_name` or `username`.", "x-found-in": "query" }, "name": { "type": "string", "description": "An API key name.\nThis parameter cannot be used with any of `id`, `realm_name` or `username`.\nIt supports prefix search with wildcard.", "x-found-in": "query" }, "owner": { "type": "boolean", "description": "A boolean flag that can be used to query API keys owned by the currently authenticated user.\nThe `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.", "x-found-in": "query" }, "realm_name": { "type": "string", "description": "The name of an authentication realm.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", "x-found-in": "query" }, "username": { "type": "string", "description": "The username of a user.\nThis parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.", "x-found-in": "query" }, "with_limited_by": { "type": "boolean", "description": "Return the snapshot of the owner user's role descriptors\nassociated with the API key. An API key's actual\npermission is the intersection of its assigned role\ndescriptors and the owner user's role descriptors.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.5.0" }, "serverless": {} } }, "active_only": { "type": "boolean", "description": "A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.10.0" }, "serverless": {} } }, "with_profile_uid": { "type": "boolean", "description": "Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.", "x-found-in": "query", "x-availability": { "stack": { "since": "8.14.0" }, "serverless": {} } }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_builtin_privileges.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_builtin_privileges", "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "x-api": { "id": "security.get_builtin_privileges", "name": "get-builtin-privileges", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/privilege/_builtin", "x-urls": [{ "path": "/_security/privilege/_builtin", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_builtin_privileges", "description": "Get builtin privileges.\n\nGet the list of cluster privileges and index privileges that are available in this version of Elasticsearch.", "x-api": { "id": "security.get_builtin_privileges", "name": "get-builtin-privileges", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/privilege/_builtin", "x-urls": [{ "path": "/_security/privilege/_builtin", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.3.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_privileges.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_privileges", "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "x-api": { "id": "security.get_privileges", "name": "get-privileges", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/privilege/{application}/{name}", "x-urls": [{ "path": "/_security/privilege", "methods": ["GET"] }, { "path": "/_security/privilege/{application}", "methods": ["GET"] }, { "path": "/_security/privilege/{application}/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "application": { "type": "string", "description": "The name of the application.\nApplication privileges are always associated with exactly one application.\nIf you do not specify this parameter, the API returns information about all privileges for all applications.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the privilege.\nIf you do not specify this parameter, the API returns information about all privileges for the requested application.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_privileges", "description": "Get application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.", "x-api": { "id": "security.get_privileges", "name": "get-privileges", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/privilege/{application}/{name}", "x-urls": [{ "path": "/_security/privilege", "methods": ["GET"] }, { "path": "/_security/privilege/{application}", "methods": ["GET"] }, { "path": "/_security/privilege/{application}/{name}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "6.4.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "application": { "type": "string", "description": "The name of the application.\nApplication privileges are always associated with exactly one application.\nIf you do not specify this parameter, the API returns information about all privileges for all applications.", "x-found-in": "path" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the privilege.\nIf you do not specify this parameter, the API returns information about all privileges for the requested application.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_role.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_role", "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "x-api": { "id": "security.get_role", "name": "get-role", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/role/{name}", "x-urls": [{ "path": "/_security/role/{name}", "methods": ["GET"] }, { "path": "/_security/role", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "include_implicit": { "type": "boolean", "description": "If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges.\nEach implicit entry in the response is annotated with `implicitly_granted: true`.", "x-found-in": "query", "x-availability": { "stack": { "since": "9.5.0" }, "serverless": {} } }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_role", "description": "Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files.", "x-api": { "id": "security.get_role", "name": "get-role", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/role/{name}", "x-urls": [{ "path": "/_security/role/{name}", "methods": ["GET"] }, { "path": "/_security/role", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "include_implicit": { "type": "boolean", "description": "If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges.\nEach implicit entry in the response is annotated with `implicitly_granted: true`.", "x-found-in": "query", "x-availability": { "stack": { "since": "9.5.0" }, "serverless": {} } }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_role_mapping.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_role_mapping", "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "x-api": { "id": "security.get_role_mapping", "name": "get-role-mapping", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/role_mapping/{name}", "x-urls": [{ "path": "/_security/role_mapping/{name}", "methods": ["GET"] }, { "path": "/_security/role_mapping", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_role_mapping", "description": "Get role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe get role mappings API cannot retrieve role mappings that are defined in role mapping files.", "x-api": { "id": "security.get_role_mapping", "name": "get-role-mapping", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/role_mapping/{name}", "x-urls": [{ "path": "/_security/role_mapping/{name}", "methods": ["GET"] }, { "path": "/_security/role_mapping", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.5.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_service_accounts.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_service_accounts", "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "x-api": { "id": "security.get_service_accounts", "name": "get-service-accounts", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/service/{namespace}/{service}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}", "methods": ["GET"] }, { "path": "/_security/service/{namespace}", "methods": ["GET"] }, { "path": "/_security/service", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.\nOmit this parameter to retrieve information about all service accounts.\nIf you omit this parameter, you must also omit the `service` parameter.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.\nOmit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.", "x-found-in": "path" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_service_accounts", "description": "Get service accounts.\n\nGet a list of service accounts that match the provided path parameters.\n\nNOTE: Currently, only the `elastic/fleet-server` service account is available.", "x-api": { "id": "security.get_service_accounts", "name": "get-service-accounts", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/service/{namespace}/{service}", "x-urls": [{ "path": "/_security/service/{namespace}/{service}", "methods": ["GET"] }, { "path": "/_security/service/{namespace}", "methods": ["GET"] }, { "path": "/_security/service", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.\nOmit this parameter to retrieve information about all service accounts.\nIf you omit this parameter, you must also omit the `service` parameter.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.\nOmit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_service_credentials.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_service_credentials", "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", "x-api": { "id": "security.get_service_credentials", "name": "get-service-credentials", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/service/{namespace}/{service}/credential", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.", "x-found-in": "path" } }, "required": ["namespace", "service"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_service_credentials", "description": "Get service account credentials.\n\nTo use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).\n\nThe response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.\n\nNOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.\nTokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.", "x-api": { "id": "security.get_service_credentials", "name": "get-service-credentials", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/service/{namespace}/{service}/credential", "x-urls": [{ "path": "/_security/service/{namespace}/{service}/credential", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "7.13.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "namespace": { "type": "string", "description": "The name of the namespace.", "x-found-in": "path" }, "service": { "type": "string", "description": "The service name.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["namespace", "service"] }

package/lib/es/json/security.get_settings.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_settings", "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", "x-api": { "id": "security.get_settings", "name": "get-settings", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/settings", "x-urls": [{ "path": "/_security/settings", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_settings", "description": "Get security index settings.\n\nGet the user-configurable settings for the security internal index (`.security` and associated indices).\nOnly a subset of the index settings — those that are user-configurable—will be shown.\nThis includes:\n\n* `index.auto_expand_replicas`\n* `index.number_of_replicas`", "x-api": { "id": "security.get_settings", "name": "get-settings", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/settings", "x-urls": [{ "path": "/_security/settings", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable", "visibility": "public" } }, "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/security.get_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_stats", "description": "Get security stats.\n\nGather security usage statistics from all node(s) within the cluster.", "x-api": { "id": "security.get_stats", "name": "get-stats", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/stats", "x-urls": [{ "path": "/_security/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": {} }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "security.get_stats", "description": "Get security stats.\n\nGather security usage statistics from all node(s) within the cluster.", "x-api": { "id": "security.get_stats", "name": "get-stats", "namespace": "security" }, "x-method": "GET", "x-path": "/_security/stats", "x-urls": [{ "path": "/_security/stats", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "9.2.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "private" } }, "type": "object", "properties": { "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }