elasticsearch-api 9.0.3 → 9.1.0

data/lib/elasticsearch/api/actions/security/invalidate_token.rb

@@ -25,18 +25,29 @@ module Elasticsearch
         # Invalidate a token.
         # The access tokens returned by the get token API have a finite period of time for which they are valid.
         # After that time period, they can no longer be used.
-        # The time period is defined by the +xpack.security.authc.token.timeout+ setting.
+        # The time period is defined by the `xpack.security.authc.token.timeout` setting.
         # The refresh tokens returned by the get token API are only valid for 24 hours.
         # They can also be used exactly once.
         # If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.
         # NOTE: While all parameters are optional, at least one of them is required.
-        # More specifically, either one of +token+ or +refresh_token+ parameters is required.
-        # If none of these two are specified, then +realm_name+ and/or +username+ need to be specified.
+        # More specifically, either one of `token` or `refresh_token` parameters is required.
+        # If none of these two are specified, then `realm_name` and/or `username` need to be specified.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-invalidate-token
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-token
         #
         def invalidate_token(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_token' }
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_DELETE
           path   = '_security/oauth2/token'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb

@@ -27,10 +27,21 @@ module Elasticsearch
         # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
         # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-authenticate
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-authenticate
         #
         def oidc_authenticate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_authenticate' }
@@ -44,7 +55,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/oidc/authenticate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/oidc_logout.rb

@@ -23,15 +23,26 @@ module Elasticsearch
     module Security
       module Actions
         # Logout of OpenID Connect.
-        # Invalidate an access token and a refresh token that were generated as a response to the +/_security/oidc/authenticate+ API.
+        # Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API.
         # If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout.
         # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
         # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-logout
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-logout
         #
         def oidc_logout(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_logout' }
@@ -45,7 +56,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/oidc/logout'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb

@@ -28,10 +28,21 @@ module Elasticsearch
         # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs.
         # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-prepare-authentication
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-oidc-prepare-authentication
         #
         def oidc_prepare_authentication(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_prepare_authentication' }
@@ -45,7 +56,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/oidc/prepare'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/put_privileges.rb

@@ -24,23 +24,34 @@ module Elasticsearch
       module Actions
         # Create or update application privileges.
         # To use this API, you must have one of the following privileges:
-        # * The +manage_security+ cluster privilege (or a greater privilege such as +all+).
+        # * The `manage_security` cluster privilege (or a greater privilege such as `all`).
         # * The "Manage Application Privileges" global privilege for the application being referenced in the request.
         # Application names are formed from a prefix, with an optional suffix that conform to the following rules:
         # * The prefix must begin with a lowercase ASCII letter.
         # * The prefix must contain only ASCII letters or digits.
         # * The prefix must be at least 3 characters long.
-        # * If the suffix exists, it must begin with either a dash +-+ or +_+.
-        # * The suffix cannot contain any of the following characters: +\+, +/+, +*+, +?+, +"+, +<+, +>+, +|+, +,+, +*+.
+        # * If the suffix exists, it must begin with either a dash `-` or `_`.
+        # * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`.
         # * No part of the name can contain whitespace.
-        # Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters +_+, +-+, and +.+.
-        # Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: +/+, +*+, +:+.
+        # Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.
+        # Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`.
         #
-        # @option arguments [String] :refresh 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.
+        # @option arguments [String] :refresh 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.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body privileges
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-privileges
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-privileges
         #
         def put_privileges(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.put_privileges' }

data/lib/elasticsearch/api/actions/security/put_role.rb

@@ -28,11 +28,22 @@ module Elasticsearch
         # File-based role management is not available in Elastic Serverless.
         #
         # @option arguments [String] :name The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. (*Required*)
-        # @option arguments [String] :refresh 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.
+        # @option arguments [String] :refresh 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.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role
         #
         def put_role(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.put_role' }

data/lib/elasticsearch/api/actions/security/put_role_mapping.rb

@@ -30,10 +30,10 @@ module Elasticsearch
         # Roles can be created by using the create or update roles API or roles files.
         # **Role templates**
         # The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.
-        # For example, all users in the +cn=admin,dc=example,dc=com+ LDAP group should be given the superuser role in Elasticsearch.
-        # The +roles+ field is used for this purpose.
+        # For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.
+        # The `roles` field is used for this purpose.
         # For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.
-        # The +role_templates+ field is used for this purpose.
+        # The `role_templates` field is used for this purpose.
         # NOTE: To use role templates successfully, the relevant scripting feature must be enabled.
         # Otherwise, all attempts to create a role mapping with role templates fail.
         # All of the user fields that are available in the role mapping rules are also available in the role templates.
@@ -43,11 +43,22 @@ module Elasticsearch
         #
         # @option arguments [String] :name 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. (*Required*)
-        # @option arguments [String] :refresh 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.
+        # @option arguments [String] :refresh 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.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role-mapping
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-role-mapping
         #
         def put_role_mapping(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.put_role_mapping' }

data/lib/elasticsearch/api/actions/security/put_user.rb

@@ -30,12 +30,23 @@ module Elasticsearch
         # @option arguments [String] :username An identifier for the user.NOTE: Usernames must be at least 1 and no more than 507 characters.
         #  They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.
         #  Leading or trailing whitespace is not allowed. (*Required*)
-        # @option arguments [String] :refresh Valid values are +true+, +false+, and +wait_for+.
+        # @option arguments [String] :refresh Valid values are `true`, `false`, and `wait_for`.
         #  These values have the same meaning as in the index API, but the default value for this API is true. Server default: true.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-user
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-put-user
         #
         def put_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.put_user' }

data/lib/elasticsearch/api/actions/security/query_api_keys.rb

@@ -25,20 +25,32 @@ module Elasticsearch
         # Find API keys with a query.
         # Get a paginated list of API keys and their information.
         # You can optionally filter the results with a query.
-        # To use this API, you must have at least the +manage_own_api_key+ or the +read_security+ cluster privileges.
-        # If you have only the +manage_own_api_key+ privilege, this API returns only the API keys that you own.
-        # If you have the +read_security+, +manage_api_key+, or greater privileges (including +manage_security+), this API returns all API keys regardless of ownership.
+        # To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
+        # If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
+        # If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
+        # Refer to the linked documentation for examples of how to find API keys:
         #
         # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
         #  An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).
-        #  An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has +manage_api_key+ or higher privileges.
+        #  An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.
         # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile UID for the API key owner principal.
-        #  If it exists, the profile UID is returned under the +profile_uid+ response field for each API key.
+        #  If it exists, the profile UID is returned under the `profile_uid` response field for each API key.
         # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-api-keys
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-api-keys
         #
         def query_api_keys(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_api_keys' }

data/lib/elasticsearch/api/actions/security/query_role.rb

@@ -29,10 +29,21 @@ module Elasticsearch
         # You can optionally filter the results with a query.
         # Also, the results can be paginated and sorted.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-role
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role
         #
         def query_role(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_role' }
@@ -49,7 +60,7 @@ module Elasticsearch
                    end
 
           path   = '_security/_query/role'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/query_user.rb

@@ -29,10 +29,21 @@ module Elasticsearch
         # This API is only for native users.
         #
         # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users.
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-user
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-user
         #
         def query_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_user' }

data/lib/elasticsearch/api/actions/security/saml_authenticate.rb

@@ -29,14 +29,25 @@ module Elasticsearch
         # The SAML message that is submitted can be:
         # * A response to a SAML authentication request that was previously created using the SAML prepare authentication API.
         # * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.
-        # In either case, the SAML message needs to be a base64 encoded XML document with a root element of +<Response>+.
+        # In either case, the SAML message needs to be a base64 encoded XML document with a root element of `<Response>`.
         # After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.
         # This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-authenticate
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-authenticate
         #
         def saml_authenticate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_authenticate' }
@@ -50,7 +61,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/authenticate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb

@@ -32,10 +32,21 @@ module Elasticsearch
         # The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.
         # The caller of this API must prepare the request accordingly so that this API can handle either of them.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-complete-logout
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-complete-logout
         #
         def saml_complete_logout(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_complete_logout' }
@@ -49,7 +60,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/complete_logout'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_invalidate.rb

@@ -27,14 +27,25 @@ module Elasticsearch
         # NOTE: This API is intended for use by custom web applications other than Kibana.
         # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
         # The logout request comes from the SAML IdP during an IdP initiated Single Logout.
-        # The custom web application can use this API to have Elasticsearch process the +LogoutRequest+.
+        # The custom web application can use this API to have Elasticsearch process the `LogoutRequest`.
         # After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message.
         # Thus the user can be redirected back to their IdP.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-invalidate
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-invalidate
         #
         def saml_invalidate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_invalidate' }
@@ -48,7 +59,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/invalidate'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_logout.rb

@@ -29,10 +29,21 @@ module Elasticsearch
         # This API invalidates the tokens that were generated for a user by the SAML authenticate API.
         # If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-logout
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-logout
         #
         def saml_logout(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_logout' }
@@ -46,7 +57,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/logout'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb

@@ -23,21 +23,32 @@ module Elasticsearch
     module Security
       module Actions
         # Prepare SAML authentication.
-        # Create a SAML authentication request (+<AuthnRequest>+) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
+        # Create a SAML authentication request (`<AuthnRequest>`) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
         # NOTE: This API is intended for use by custom web applications other than Kibana.
         # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
         # This API returns a URL pointing to the SAML Identity Provider.
         # You can use the URL to redirect the browser of the user in order to continue the authentication process.
-        # The URL includes a single parameter named +SAMLRequest+, which contains a SAML Authentication request that is deflated and Base64 encoded.
-        # If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named +SigAlg+ and +Signature+.
+        # The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.
+        # If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.
         # These parameters contain the algorithm used for the signature and the signature value itself.
         # It also returns a random string that uniquely identifies this SAML Authentication request.
         # The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.
         #
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-prepare-authentication
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-prepare-authentication
         #
         def saml_prepare_authentication(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_prepare_authentication' }
@@ -51,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/prepare'
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)

data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb

@@ -28,9 +28,20 @@ module Elasticsearch
         # This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.
         #
         # @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*Required*)
+        # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
+        #  when they occur.
+        # @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
+        #  returned by Elasticsearch.
+        # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
+        #  For example `"exists_time": "1h"` for humans and
+        #  `"exists_time_in_millis": 3600000` for computers. When disabled the human
+        #  readable values will be omitted. This makes sense for responses being consumed
+        #  only by machines.
+        # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
+        #  this option for debugging only.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-service-provider-metadata
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-saml-service-provider-metadata
         #
         def saml_service_provider_metadata(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_service_provider_metadata' }
@@ -51,7 +62,7 @@ module Elasticsearch
 
           method = Elasticsearch::API::HTTP_GET
           path   = "_security/saml/metadata/#{Utils.listify(_realm_name)}"
-          params = {}
+          params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(
             perform_request(method, path, params, body, headers, request_opts)