elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,21 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Adds and updates users in the native realm. These users are commonly referred to as native users.
+        # Create or update users.
+        # Add and update users in the native realm.
+        # A password is required for adding a new user but is optional when updating an existing user.
+        # To change a user's password without updating any other fields, use the change password API.
         #
-        # @option arguments [String] :username The username of the User
-        # @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. (options: true, false, wait_for)
+        # @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+.
+        #  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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The user to add (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-user.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-user
         #
         def put_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.put_user' }
@@ -50,7 +56,7 @@ module Elasticsearch
           _username = arguments.delete(:username)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/user/#{Utils.__listify(_username)}"
+          path   = "_security/user/#{Utils.listify(_username)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,22 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Retrieves information for API keys using a subset of query DSL
+        # 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.
         #
-        # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys
-        # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists
-        # @option arguments [Boolean] :typed_keys flag to prefix aggregation names by their respective types in the response
+        # @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.
+        # @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.
+        # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body From, size, query, sort and search_after
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-api-keys
         #
         def query_api_keys(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_api_keys' }
@@ -38,7 +46,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST
@@ -46,7 +54,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = '_security/_query/api_key'
+          path   = '_security/_query/api_key'
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,19 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Retrieves information for Roles using a subset of query DSL
+        # Find roles with a query.
+        # Get roles in a paginated manner.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The query roles API does not retrieve roles that are defined in roles files, nor built-in ones.
+        # You can optionally filter the results with a query.
+        # Also, the results can be paginated and sorted.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body From, size, query, sort and search_after
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-role.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-role
         #
         def query_role(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_role' }
@@ -35,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST
@@ -43,7 +48,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = '_security/_query/role'
+          path   = '_security/_query/role'
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Retrieves information for Users using a subset of query DSL
+        # Find users with a query.
+        # Get information for users in a paginated manner.
+        # You can optionally filter the results with a query.
+        # NOTE: As opposed to the get user API, built-in users are excluded from the result.
+        # This API is only for native users.
         #
-        # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user
+        # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body From, size, query, sort and search_after
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-user.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-user
         #
         def query_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.query_user' }
@@ -36,7 +40,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST
@@ -44,7 +48,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = '_security/_query/user'
+          path   = '_security/_query/user'
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,19 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
+        # Authenticate SAML.
+        # Submit a SAML response message to Elasticsearch for consumption.
+        # 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 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>+.
+        # 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The SAML response to authenticate (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-authenticate.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-authenticate
         #
         def saml_authenticate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_authenticate' }
@@ -37,7 +46,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/authenticate'

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

@@ -15,19 +15,27 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Verifies the logout response sent from the SAML IdP
+        # Logout of SAML completely.
+        # Verifies the logout response sent from the SAML IdP.
+        # 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 SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout.
+        # This API verifies the response by ensuring the content is relevant and validating its signature.
+        # An empty response is returned if the verification process is successful.
+        # 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The logout response to verify (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-complete-logout.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-complete-logout
         #
         def saml_complete_logout(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_complete_logout' }
@@ -37,7 +45,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/complete_logout'

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

@@ -15,19 +15,26 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Consumes a SAML LogoutRequest
+        # Invalidate SAML.
+        # Submit a SAML LogoutRequest message to Elasticsearch for consumption.
+        # 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+.
+        # 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The LogoutRequest message (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-invalidate.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-invalidate
         #
         def saml_invalidate(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_invalidate' }
@@ -37,7 +44,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/invalidate'

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

@@ -15,19 +15,24 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
+        # Logout of SAML.
+        # Submits a request to invalidate an access token and refresh token.
+        # 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 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The tokens to invalidate (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-logout.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-logout
         #
         def saml_logout(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_logout' }
@@ -37,7 +42,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/logout'

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

@@ -15,19 +15,29 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Creates a SAML authentication request
+        # Prepare SAML authentication.
+        # 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+.
+        # 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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The realm for which to create the authentication request, identified by either its name or the ACS URL (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-prepare-authentication.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-prepare-authentication
         #
         def saml_prepare_authentication(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_prepare_authentication' }
@@ -37,7 +47,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_POST
           path   = '_security/saml/prepare'

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

@@ -15,19 +15,22 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
+        # Create SAML service provider metadata.
+        # Generate SAML metadata for a SAML 2.0 Service Provider.
+        # The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file.
+        # 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 to get the metadata for
+        # @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-sp-metadata.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-service-provider-metadata
         #
         def saml_service_provider_metadata(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.saml_service_provider_metadata' }
@@ -47,7 +50,7 @@ module Elasticsearch
           _realm_name = arguments.delete(:realm_name)
 
           method = Elasticsearch::API::HTTP_GET
-          path   = "_security/saml/metadata/#{Utils.__listify(_realm_name)}"
+          path   = "_security/saml/metadata/#{Utils.listify(_realm_name)}"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,28 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
+        # Suggest a user profile.
         # Get suggestions for user profiles that match specified search criteria.
+        # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.
+        # Individual users and external applications should not call this API directly.
+        # Elastic reserves the right to change or remove this feature in future releases without prior notice.
         #
-        # @option arguments [List] :data A comma-separated list of keys for which the corresponding application data are retrieved.
+        # @option arguments [String] :data A comma-separated list of filters for the +data+ field of the profile document.
+        #  To return all content use +data=*+.
+        #  To return a subset of content, use +data=<key>+ to retrieve content nested under the specified +<key>+.
+        #  By default, the API returns no +data+ content.
+        #  It is an error to specify +data+ as both the query parameter and the request body field.
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The suggestion definition for user profiles
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-suggest-user-profile.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-suggest-user-profiles
         #
         def suggest_user_profiles(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.suggest_user_profiles' }
@@ -36,7 +44,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = if body
                      Elasticsearch::API::HTTP_POST
@@ -44,7 +52,7 @@ module Elasticsearch
                      Elasticsearch::API::HTTP_GET
                    end
 
-          path = '_security/profile/_suggest'
+          path   = '_security/profile/_suggest'
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,33 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Updates attributes of an existing API key.
+        # Update an API key.
+        # Update attributes of an existing API key.
+        # This API supports updates to an API key's access scope, expiration, and metadata.
+        # To use this API, you must have at least the +manage_own_api_key+ cluster privilege.
+        # Users can only update API keys that they created or that were granted to them.
+        # To update another user’s API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
+        # Use this API to update API keys created by the create API key or grant API Key APIs.
+        # If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
+        # It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
+        # The access scope of an 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.
+        # The snapshot of the owner's permissions is updated automatically on every call.
+        # IMPORTANT: If you don't specify +role_descriptors+ in the request, a call to this API might still change the 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.
         #
-        # @option arguments [String] :id The ID of the API key to update
+        # @option arguments [String] :id The ID of the API key to update. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The API key request to update attributes of an API key.
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-api-key
         #
         def update_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' }
@@ -48,7 +61,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/api_key/#{Utils.__listify(_id)}"
+          path   = "_security/api_key/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,30 @@
 # specific language governing permissions and limitations
 # under the License.
 #
-# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
-# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
-#
+# This code was automatically generated from the Elasticsearch Specification
+# See https://github.com/elastic/elasticsearch-specification
+# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash.
 module Elasticsearch
   module API
     module Security
       module Actions
-        # Updates attributes of an existing cross-cluster API key.
+        # Update a cross-cluster API key.
+        # Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.
+        # To use this API, you must have at least the +manage_security+ cluster privilege.
+        # Users can only update API keys that they created.
+        # To update another user's API key, use the +run_as+ feature to submit a request on behalf of another user.
+        # IMPORTANT: It's not possible to use an API key as the authentication credential for this API.
+        # To update an API key, the owner user's credentials are required.
+        # It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.
+        # This API supports updates to an API key's access scope, metadata, and expiration.
+        # The owner user's information, such as the +username+ and +realm+, is also updated automatically on every call.
+        # NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.
         #
-        # @option arguments [String] :id The ID of the cross-cluster API key to update
+        # @option arguments [String] :id The ID of the cross-cluster API key to update. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The request to update attributes of a cross-cluster API key. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-cross-cluster-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-cross-cluster-api-key
         #
         def update_cross_cluster_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.update_cross_cluster_api_key' }
@@ -49,7 +59,7 @@ module Elasticsearch
           _id = arguments.delete(:id)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/cross_cluster/api_key/#{Utils.__listify(_id)}"
+          path   = "_security/cross_cluster/api_key/#{Utils.listify(_id)}"
           params = {}
 
           Elasticsearch::API::Response.new(