elasticsearch-api 8.18.0 → 9.0.1

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

@@ -15,26 +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
-        # Evicts tokens from the service account token caches.
+        # Clear service account token caches.
+        # Evict a subset of all entries from the service account token caches.
+        # Two 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.
+        # This API clears matching entries from both caches.
+        # The cache for service account tokens backed by the +.security+ index is cleared automatically on state changes of the security index.
+        # The cache for tokens backed by the +service_tokens+ file is cleared automatically on file changes.
         #
-        # @option arguments [String] :namespace An identifier for the namespace
-        # @option arguments [String] :service An identifier for the service name
-        # @option arguments [List] :name A comma-separated list of service token names
+        # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
+        # @option arguments [String] :service The name of the service, which must be unique within its namespace. (*Required*)
+        # @option arguments [String, Array<String>] :name A comma-separated list of token names to evict from the service account token caches.
+        #  Use a wildcard (+*+) to evict all tokens that belong to a service account.
+        #  It does not support other wildcard patterns. (*Required*)
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-service-token-caches.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-service-tokens
         #
         def clear_cached_service_tokens(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_service_tokens' }
 
-          defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables|
+          defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -55,7 +62,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_POST
-          path   = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}/_clear_cache"
+          path   = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}/_clear_cache"
           params = {}
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/security/create_api_key.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
-        # Creates an API key for access without requiring basic authentication.
+        # Create an API key.
+        # Create an API key for access without requiring basic authentication.
+        # IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.
+        # If you specify privileges, the API returns an error.
+        # A 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.
+        # NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.
+        # The API keys are created by the Elasticsearch API key service, which is automatically enabled.
+        # To configure or turn off the API key service, refer to API key service setting documentation.
         #
-        # @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] :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 [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The api key request to create an API key (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-api-key
         #
         def create_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.create_api_key' }
@@ -38,7 +46,7 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = arguments.delete(:body)
+          body = arguments.delete(:body)
 
           method = Elasticsearch::API::HTTP_PUT
           path   = '_security/api_key'

data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.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
-        # Creates a cross-cluster API key for API key based remote cluster access.
+        # Create a cross-cluster API key.
+        # Create an API key of the +cross_cluster+ type for the API key based remote cluster access.
+        # A +cross_cluster+ API key cannot be used to authenticate through the REST interface.
+        # IMPORTANT: 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.
+        # Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.
+        # NOTE: 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.
+        # A 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.
+        # By default, API keys never expire. You can specify expiration information when you create the API keys.
+        # Cross-cluster API keys can only be updated with the update cross-cluster API key API.
+        # Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The request to create 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-create-cross-cluster-api-key.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-cross-cluster-api-key
         #
         def create_cross_cluster_api_key(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.create_cross_cluster_api_key' }
@@ -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/cross_cluster/api_key'

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

@@ -15,27 +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
-        # Creates a service account token for access without requiring basic authentication.
+        # Create a service account token.
+        # Create a service accounts token for access without requiring basic authentication.
+        # NOTE: Service account tokens never expire.
+        # You must actively delete them if they are no longer needed.
         #
-        # @option arguments [String] :namespace An identifier for the namespace
-        # @option arguments [String] :service An identifier for the service name
-        # @option arguments [String] :name An identifier for the token name
-        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) 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] :namespace The name of the namespace, which is a top-level grouping of service accounts. (*Required*)
+        # @option arguments [String] :service The name of the service. (*Required*)
+        # @option arguments [String] :name The name for the service account token.
+        #  If omitted, a random name will be generated.Token names must be at least one and no more than 256 characters.
+        #  They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (+-+), and underscores (+_+), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account.
+        #  They 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>+.
+        # @option arguments [String] :refresh If +true+ then refresh the affected shards to make this operation visible to search, if +wait_for+ (the default) then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-service-token.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-service-token
         #
         def create_service_token(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.create_service_token' }
 
-          defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables|
+          defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -56,9 +62,9 @@ module Elasticsearch
 
           method = _name ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST
           path   = if _namespace && _service && _name
-                     "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}"
+                     "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}"
                    else
-                     "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token"
+                     "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token"
                    end
           params = Utils.process_params(arguments)
 

data/lib/elasticsearch/api/actions/security/delegate_pki.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
         # Delegate PKI authentication.
+        # This API implements the exchange of an X509Certificate chain for an Elasticsearch access token.
+        # The 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+.
+        # A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw +username_pattern+ of the respective realm.
+        # This 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.
+        # IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated.
+        # This is part of the TLS authentication process and it is delegated to the proxy that calls this API.
+        # The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.
         #
         # @option arguments [Hash] :headers Custom HTTP headers
-        # @option arguments [Hash] :body The X509Certificate chain. (*Required*)
+        # @option arguments [Hash] :body request body
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delegate-pki-authentication.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delegate-pki
         #
         def delegate_pki(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delegate_pki' }
@@ -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/delegate_pki'

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

@@ -15,26 +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
-        # Removes application privileges.
+        # Delete 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 Application Privileges" global privilege for the application being referenced in the request.
         #
-        # @option arguments [String] :application Application name
-        # @option arguments [String] :name Privilege name
-        # @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] :application The name of the application.
+        #  Application privileges are always associated with exactly one application. (*Required*)
+        # @option arguments [String, Array<String>] :name The name of the privilege. (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-privilege.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-privileges
         #
         def delete_privileges(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delete_privileges' }
 
-          defined_params = %i[application name].each_with_object({}) do |variable, set_variables|
+          defined_params = [:application, :name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -52,7 +56,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_security/privilege/#{Utils.__listify(_application)}/#{Utils.__listify(_name)}"
+          path   = "_security/privilege/#{Utils.listify(_application)}/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,23 @@
 # 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
-        # Removes roles in the native realm.
+        # Delete roles.
+        # Delete roles in the native realm.
+        # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
+        # The delete roles API cannot remove roles that are defined in roles files.
         #
-        # @option arguments [String] :name Role name
-        # @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] :name The name of the 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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-role
         #
         def delete_role(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role' }
@@ -48,7 +51,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_security/role/#{Utils.__listify(_name)}"
+          path   = "_security/role/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/security/delete_role_mapping.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
-        # Removes role mappings.
+        # Delete role mappings.
+        # Role mappings define which roles are assigned to each user.
+        # The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.
+        # The delete role mappings API cannot remove role mappings that are defined in role mapping files.
         #
-        # @option arguments [String] :name Role-mapping name
-        # @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] :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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role-mapping.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-role-mapping
         #
         def delete_role_mapping(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role_mapping' }
@@ -48,7 +52,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_security/role_mapping/#{Utils.__listify(_name)}"
+          path   = "_security/role_mapping/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,27 +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
-        # Deletes a service account token.
+        # Delete service account tokens.
+        # Delete service account tokens for a service in a specified namespace.
         #
-        # @option arguments [String] :namespace An identifier for the namespace
-        # @option arguments [String] :service An identifier for the service name
-        # @option arguments [String] :name An identifier for the token name
-        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) 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] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*)
+        # @option arguments [String] :service The service name. (*Required*)
+        # @option arguments [String] :name The name of the service account token. (*Required*)
+        # @option arguments [String] :refresh If +true+ then refresh the affected shards to make this operation visible to search, if +wait_for+ (the default) then wait for a refresh to make this operation visible to search, if +false+ then do nothing with refreshes.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-service-token.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-service-token
         #
         def delete_service_token(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delete_service_token' }
 
-          defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables|
+          defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables|
             set_variables[variable] = arguments[variable] if arguments.key?(variable)
           end
           request_opts[:defined_params] = defined_params unless defined_params.empty?
@@ -56,7 +57,7 @@ module Elasticsearch
           _name = arguments.delete(:name)
 
           method = Elasticsearch::API::HTTP_DELETE
-          path   = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}"
+          path   = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +15,21 @@
 # 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
-        # Deletes users from the native realm.
+        # Delete users.
+        # Delete users from the native realm.
         #
-        # @option arguments [String] :username username
-        # @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. (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-user.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-user
         #
         def delete_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.delete_user' }
@@ -48,7 +49,7 @@ module Elasticsearch
           _username = arguments.delete(:username)
 
           method = Elasticsearch::API::HTTP_DELETE
-          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/disable_user.rb

@@ -15,20 +15,23 @@
 # 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
-        # Disables users in the native realm.
+        # Disable users.
+        # Disable users in the native realm.
+        # By default, when you create users, they are enabled.
+        # You can use this API to revoke a user's access to Elasticsearch.
         #
-        # @option arguments [String] :username The username of the user to disable
-        # @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. (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-disable-user
         #
         def disable_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user' }
@@ -48,7 +51,7 @@ module Elasticsearch
           _username = arguments.delete(:username)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/user/#{Utils.__listify(_username)}/_disable"
+          path   = "_security/user/#{Utils.listify(_username)}/_disable"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

data/lib/elasticsearch/api/actions/security/disable_user_profile.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
-        # Disables a user profile so it's not visible in user profile searches.
+        # Disable a user profile.
+        # Disable user profiles so that they are not visible in user profile searches.
+        # 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.
+        # When 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.
+        # To re-enable a disabled user profile, use the enable user profile API .
         #
-        # @option arguments [String] :uid Unique identifier for the user profile
-        # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) 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] :uid Unique identifier for the user profile. (*Required*)
+        # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.
+        #  If 'wait_for', it waits for a refresh to make this operation visible to search.
+        #  If 'false', it does nothing with refreshes. Server default: false.
         # @option arguments [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user-profile.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-disable-user-profile
         #
         def disable_user_profile(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user_profile' }
@@ -43,12 +51,12 @@ module Elasticsearch
           arguments = arguments.clone
           headers = arguments.delete(:headers) || {}
 
-          body   = nil
+          body = nil
 
           _uid = arguments.delete(:uid)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/profile/#{Utils.__listify(_uid)}/_disable"
+          path   = "_security/profile/#{Utils.listify(_uid)}/_disable"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(

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

@@ -15,20 +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
-        # Enables users in the native realm.
+        # Enable users.
+        # Enable users in the native realm.
+        # By default, when you create users, they are enabled.
         #
-        # @option arguments [String] :username The username of the user to enable
-        # @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. (*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 [Hash] :headers Custom HTTP headers
         #
-        # @see https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user.html
+        # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enable-user
         #
         def enable_user(arguments = {})
           request_opts = { endpoint: arguments[:endpoint] || 'security.enable_user' }
@@ -48,7 +50,7 @@ module Elasticsearch
           _username = arguments.delete(:username)
 
           method = Elasticsearch::API::HTTP_PUT
-          path   = "_security/user/#{Utils.__listify(_username)}/_enable"
+          path   = "_security/user/#{Utils.listify(_username)}/_enable"
           params = Utils.process_params(arguments)
 
           Elasticsearch::API::Response.new(