elasticsearch-api 9.0.3 → 9.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +1 -0
- data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
- data/lib/elasticsearch/api/actions/bulk.rb +86 -63
- data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
- data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
- data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
- data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
- data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
- data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
- data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
- data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
- data/lib/elasticsearch/api/actions/count.rb +29 -18
- data/lib/elasticsearch/api/actions/create.rb +44 -41
- data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
- data/lib/elasticsearch/api/actions/delete.rb +25 -12
- data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
- data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
- data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
- data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
- data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
- data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
- data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
- data/lib/elasticsearch/api/actions/exists.rb +31 -18
- data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
- data/lib/elasticsearch/api/actions/explain.rb +25 -14
- data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
- data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
- data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
- data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
- data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
- data/lib/elasticsearch/api/actions/get.rb +48 -29
- data/lib/elasticsearch/api/actions/get_script.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
- data/lib/elasticsearch/api/actions/get_source.rb +24 -11
- data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
- data/lib/elasticsearch/api/actions/health_report.rb +13 -2
- data/lib/elasticsearch/api/actions/index.rb +55 -43
- data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
- data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
- data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
- data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
- data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
- data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
- data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
- data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
- data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
- data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
- data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
- data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
- data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
- data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
- data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
- data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
- data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
- data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
- data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
- data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
- data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
- data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
- data/lib/elasticsearch/api/actions/info.rb +14 -2
- data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
- data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
- data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/license/get.rb +14 -3
- data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post.rb +12 -1
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +18 -7
- data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
- data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
- data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
- data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
- data/lib/elasticsearch/api/actions/mget.rb +25 -14
- data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
- data/lib/elasticsearch/api/actions/msearch.rb +28 -11
- data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
- data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
- data/lib/elasticsearch/api/actions/ping.rb +13 -2
- data/lib/elasticsearch/api/actions/put_script.rb +14 -3
- data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
- data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
- data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
- data/lib/elasticsearch/api/actions/reindex.rb +35 -123
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
- data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
- data/lib/elasticsearch/api/actions/scroll.rb +16 -5
- data/lib/elasticsearch/api/actions/search.rb +71 -60
- data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
- data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
- data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
- data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
- data/lib/elasticsearch/api/actions/search_template.rb +24 -14
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
- data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
- data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
- data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
- data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
- data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
- data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
- data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
- data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
- data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
- data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
- data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
- data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
- data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
- data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
- data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
- data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
- data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
- data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
- data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
- data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
- data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
- data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
- data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
- data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
- data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
- data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
- data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
- data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
- data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
- data/lib/elasticsearch/api/actions/update.rb +20 -8
- data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
- data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
- data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
- data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
- data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
- data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +18 -4
@@ -27,9 +27,20 @@ module Elasticsearch
|
|
27
27
|
# The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster.
|
28
28
|
# The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.
|
29
29
|
#
|
30
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
31
|
+
# when they occur.
|
32
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
33
|
+
# returned by Elasticsearch.
|
34
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
35
|
+
# For example `"exists_time": "1h"` for humans and
|
36
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
37
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
38
|
+
# only by machines.
|
39
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
40
|
+
# this option for debugging only.
|
30
41
|
# @option arguments [Hash] :headers Custom HTTP headers
|
31
42
|
#
|
32
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
43
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-enroll-node
|
33
44
|
#
|
34
45
|
def enroll_node(arguments = {})
|
35
46
|
request_opts = { endpoint: arguments[:endpoint] || 'security.enroll_node' }
|
@@ -41,7 +52,7 @@ module Elasticsearch
|
|
41
52
|
|
42
53
|
method = Elasticsearch::API::HTTP_GET
|
43
54
|
path = '_security/enroll/node'
|
44
|
-
params =
|
55
|
+
params = Utils.process_params(arguments)
|
45
56
|
|
46
57
|
Elasticsearch::API::Response.new(
|
47
58
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -24,29 +24,40 @@ module Elasticsearch
|
|
24
24
|
module Actions
|
25
25
|
# Get API key information.
|
26
26
|
# Retrieves information for one or more API keys.
|
27
|
-
# NOTE: If you have only the
|
28
|
-
# If you have
|
27
|
+
# NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
|
28
|
+
# If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
|
29
29
|
#
|
30
30
|
# @option arguments [String] :id An API key id.
|
31
|
-
# This parameter cannot be used with any of
|
31
|
+
# This parameter cannot be used with any of `name`, `realm_name` or `username`.
|
32
32
|
# @option arguments [String] :name An API key name.
|
33
|
-
# This parameter cannot be used with any of
|
33
|
+
# This parameter cannot be used with any of `id`, `realm_name` or `username`.
|
34
34
|
# It supports prefix search with wildcard.
|
35
35
|
# @option arguments [Boolean] :owner A boolean flag that can be used to query API keys owned by the currently authenticated user.
|
36
|
-
# The
|
36
|
+
# The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones.
|
37
37
|
# @option arguments [String] :realm_name The name of an authentication realm.
|
38
|
-
# This parameter cannot be used with either
|
38
|
+
# This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.
|
39
39
|
# @option arguments [String] :username The username of a user.
|
40
|
-
# This parameter cannot be used with either
|
40
|
+
# This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`.
|
41
41
|
# @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors
|
42
42
|
# associated with the API key. An API key's actual
|
43
43
|
# permission is the intersection of its assigned role
|
44
44
|
# descriptors and the owner user's role descriptors.
|
45
|
-
# @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as
|
45
|
+
# @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys.
|
46
46
|
# @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
|
47
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
48
|
+
# when they occur.
|
49
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
50
|
+
# returned by Elasticsearch.
|
51
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
52
|
+
# For example `"exists_time": "1h"` for humans and
|
53
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
54
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
55
|
+
# only by machines.
|
56
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
57
|
+
# this option for debugging only.
|
47
58
|
# @option arguments [Hash] :headers Custom HTTP headers
|
48
59
|
#
|
49
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
60
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-api-key
|
50
61
|
#
|
51
62
|
def get_api_key(arguments = {})
|
52
63
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_api_key' }
|
@@ -25,9 +25,20 @@ module Elasticsearch
|
|
25
25
|
# Get builtin privileges.
|
26
26
|
# Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
27
27
|
#
|
28
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
29
|
+
# when they occur.
|
30
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
31
|
+
# returned by Elasticsearch.
|
32
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
33
|
+
# For example `"exists_time": "1h"` for humans and
|
34
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
35
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
36
|
+
# only by machines.
|
37
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
38
|
+
# this option for debugging only.
|
28
39
|
# @option arguments [Hash] :headers Custom HTTP headers
|
29
40
|
#
|
30
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
41
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-builtin-privileges
|
31
42
|
#
|
32
43
|
def get_builtin_privileges(arguments = {})
|
33
44
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_builtin_privileges' }
|
@@ -39,7 +50,7 @@ module Elasticsearch
|
|
39
50
|
|
40
51
|
method = Elasticsearch::API::HTTP_GET
|
41
52
|
path = '_security/privilege/_builtin'
|
42
|
-
params =
|
53
|
+
params = Utils.process_params(arguments)
|
43
54
|
|
44
55
|
Elasticsearch::API::Response.new(
|
45
56
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -24,7 +24,7 @@ module Elasticsearch
|
|
24
24
|
module Actions
|
25
25
|
# Get application privileges.
|
26
26
|
# To use this API, you must have one of the following privileges:
|
27
|
-
# * The
|
27
|
+
# * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`).
|
28
28
|
# * The "Manage Application Privileges" global privilege for the application being referenced in the request.
|
29
29
|
#
|
30
30
|
# @option arguments [String] :application The name of the application.
|
@@ -32,9 +32,20 @@ module Elasticsearch
|
|
32
32
|
# If you do not specify this parameter, the API returns information about all privileges for all applications.
|
33
33
|
# @option arguments [String, Array<String>] :name The name of the privilege.
|
34
34
|
# If you do not specify this parameter, the API returns information about all privileges for the requested application.
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
36
|
+
# when they occur.
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
38
|
+
# returned by Elasticsearch.
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
41
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
43
|
+
# only by machines.
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
45
|
+
# this option for debugging only.
|
35
46
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
47
|
#
|
37
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
48
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-privileges
|
38
49
|
#
|
39
50
|
def get_privileges(arguments = {})
|
40
51
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_privileges' }
|
@@ -61,7 +72,7 @@ module Elasticsearch
|
|
61
72
|
else
|
62
73
|
'_security/privilege'
|
63
74
|
end
|
64
|
-
params =
|
75
|
+
params = Utils.process_params(arguments)
|
65
76
|
|
66
77
|
Elasticsearch::API::Response.new(
|
67
78
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -30,9 +30,20 @@ module Elasticsearch
|
|
30
30
|
# @option arguments [String, Array<String>] :name The name of the role.
|
31
31
|
# You can specify multiple roles as a comma-separated list.
|
32
32
|
# If you do not specify this parameter, the API returns information about all roles.
|
33
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
34
|
+
# when they occur.
|
35
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
36
|
+
# returned by Elasticsearch.
|
37
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
38
|
+
# For example `"exists_time": "1h"` for humans and
|
39
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
40
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
41
|
+
# only by machines.
|
42
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
43
|
+
# this option for debugging only.
|
33
44
|
# @option arguments [Hash] :headers Custom HTTP headers
|
34
45
|
#
|
35
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
46
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role
|
36
47
|
#
|
37
48
|
def get_role(arguments = {})
|
38
49
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_role' }
|
@@ -28,9 +28,20 @@ module Elasticsearch
|
|
28
28
|
# The get role mappings API cannot retrieve role mappings that are defined in role mapping files.
|
29
29
|
#
|
30
30
|
# @option arguments [String, Array<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. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings.
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
31
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
32
43
|
#
|
33
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
44
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-role-mapping
|
34
45
|
#
|
35
46
|
def get_role_mapping(arguments = {})
|
36
47
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_role_mapping' }
|
@@ -53,7 +64,7 @@ module Elasticsearch
|
|
53
64
|
else
|
54
65
|
'_security/role_mapping'
|
55
66
|
end
|
56
|
-
params =
|
67
|
+
params = Utils.process_params(arguments)
|
57
68
|
|
58
69
|
Elasticsearch::API::Response.new(
|
59
70
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -24,16 +24,27 @@ module Elasticsearch
|
|
24
24
|
module Actions
|
25
25
|
# Get service accounts.
|
26
26
|
# Get a list of service accounts that match the provided path parameters.
|
27
|
-
# NOTE: Currently, only the
|
27
|
+
# NOTE: Currently, only the `elastic/fleet-server` service account is available.
|
28
28
|
#
|
29
29
|
# @option arguments [String] :namespace The name of the namespace.
|
30
30
|
# Omit this parameter to retrieve information about all service accounts.
|
31
|
-
# If you omit this parameter, you must also omit the
|
31
|
+
# If you omit this parameter, you must also omit the `service` parameter.
|
32
32
|
# @option arguments [String] :service The service name.
|
33
|
-
# Omit this parameter to retrieve information about all service accounts that belong to the specified
|
33
|
+
# Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`.
|
34
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
35
|
+
# when they occur.
|
36
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
37
|
+
# returned by Elasticsearch.
|
38
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
39
|
+
# For example `"exists_time": "1h"` for humans and
|
40
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
41
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
42
|
+
# only by machines.
|
43
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
44
|
+
# this option for debugging only.
|
34
45
|
# @option arguments [Hash] :headers Custom HTTP headers
|
35
46
|
#
|
36
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
47
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-accounts
|
37
48
|
#
|
38
49
|
def get_service_accounts(arguments = {})
|
39
50
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_accounts' }
|
@@ -60,7 +71,7 @@ module Elasticsearch
|
|
60
71
|
else
|
61
72
|
'_security/service'
|
62
73
|
end
|
63
|
-
params =
|
74
|
+
params = Utils.process_params(arguments)
|
64
75
|
|
65
76
|
Elasticsearch::API::Response.new(
|
66
77
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,16 +23,27 @@ module Elasticsearch
|
|
23
23
|
module Security
|
24
24
|
module Actions
|
25
25
|
# Get service account credentials.
|
26
|
-
# To use this API, you must have at least the
|
26
|
+
# To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`).
|
27
27
|
# The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster.
|
28
|
-
# NOTE: For tokens backed by the
|
28
|
+
# NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster.
|
29
29
|
# Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.
|
30
30
|
#
|
31
31
|
# @option arguments [String] :namespace The name of the namespace. (*Required*)
|
32
32
|
# @option arguments [String] :service The service name. (*Required*)
|
33
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
34
|
+
# when they occur.
|
35
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
36
|
+
# returned by Elasticsearch.
|
37
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
38
|
+
# For example `"exists_time": "1h"` for humans and
|
39
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
40
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
41
|
+
# only by machines.
|
42
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
43
|
+
# this option for debugging only.
|
33
44
|
# @option arguments [Hash] :headers Custom HTTP headers
|
34
45
|
#
|
35
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
46
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-service-credentials
|
36
47
|
#
|
37
48
|
def get_service_credentials(arguments = {})
|
38
49
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_credentials' }
|
@@ -56,7 +67,7 @@ module Elasticsearch
|
|
56
67
|
|
57
68
|
method = Elasticsearch::API::HTTP_GET
|
58
69
|
path = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential"
|
59
|
-
params =
|
70
|
+
params = Utils.process_params(arguments)
|
60
71
|
|
61
72
|
Elasticsearch::API::Response.new(
|
62
73
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,17 +23,28 @@ module Elasticsearch
|
|
23
23
|
module Security
|
24
24
|
module Actions
|
25
25
|
# Get security index settings.
|
26
|
-
# Get the user-configurable settings for the security internal index (
|
26
|
+
# Get the user-configurable settings for the security internal index (`.security` and associated indices).
|
27
27
|
# Only a subset of the index settings — those that are user-configurable—will be shown.
|
28
28
|
# This includes:
|
29
|
-
# *
|
30
|
-
# *
|
29
|
+
# * `index.auto_expand_replicas`
|
30
|
+
# * `index.number_of_replicas`
|
31
31
|
#
|
32
32
|
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node.
|
33
33
|
# If no response is received before the timeout expires, the request fails and returns an error.
|
34
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
35
|
+
# when they occur.
|
36
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
37
|
+
# returned by Elasticsearch.
|
38
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
39
|
+
# For example `"exists_time": "1h"` for humans and
|
40
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
41
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
42
|
+
# only by machines.
|
43
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
44
|
+
# this option for debugging only.
|
34
45
|
# @option arguments [Hash] :headers Custom HTTP headers
|
35
46
|
#
|
36
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
47
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings
|
37
48
|
#
|
38
49
|
def get_settings(arguments = {})
|
39
50
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_settings' }
|
@@ -25,18 +25,29 @@ module Elasticsearch
|
|
25
25
|
# Get a token.
|
26
26
|
# Create a bearer token for access without requiring basic authentication.
|
27
27
|
# The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface.
|
28
|
-
# Alternatively, you can explicitly enable the
|
28
|
+
# Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting.
|
29
29
|
# When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.
|
30
30
|
# The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.
|
31
31
|
# A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.
|
32
32
|
# The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used.
|
33
|
-
# That time period is defined by the
|
33
|
+
# That time period is defined by the `xpack.security.authc.token.timeout` setting.
|
34
34
|
# If you want to invalidate a token immediately, you can do so by using the invalidate token API.
|
35
35
|
#
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
36
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
48
|
# @option arguments [Hash] :body request body
|
38
49
|
#
|
39
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
50
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-token
|
40
51
|
#
|
41
52
|
def get_token(arguments = {})
|
42
53
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_token' }
|
@@ -50,7 +61,7 @@ module Elasticsearch
|
|
50
61
|
|
51
62
|
method = Elasticsearch::API::HTTP_POST
|
52
63
|
path = '_security/oauth2/token'
|
53
|
-
params =
|
64
|
+
params = Utils.process_params(arguments)
|
54
65
|
|
55
66
|
Elasticsearch::API::Response.new(
|
56
67
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -25,11 +25,22 @@ module Elasticsearch
|
|
25
25
|
# Get users.
|
26
26
|
# Get information about users in the native realm and built-in users.
|
27
27
|
#
|
28
|
-
# @option arguments [
|
28
|
+
# @option arguments [String, Array<String>] :username An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.
|
29
29
|
# @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users.
|
30
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
31
|
+
# when they occur.
|
32
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
33
|
+
# returned by Elasticsearch.
|
34
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
35
|
+
# For example `"exists_time": "1h"` for humans and
|
36
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
37
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
38
|
+
# only by machines.
|
39
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
40
|
+
# this option for debugging only.
|
30
41
|
# @option arguments [Hash] :headers Custom HTTP headers
|
31
42
|
#
|
32
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
43
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user
|
33
44
|
#
|
34
45
|
def get_user(arguments = {})
|
35
46
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_user' }
|
@@ -28,12 +28,20 @@ module Elasticsearch
|
|
28
28
|
# To check the privileges of other users, you must use the run as feature.
|
29
29
|
# To check whether a user has a specific list of privileges, use the has privileges API.
|
30
30
|
#
|
31
|
-
# @option arguments [
|
32
|
-
#
|
33
|
-
# @option arguments [
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
34
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
35
43
|
#
|
36
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
44
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-privileges
|
37
45
|
#
|
38
46
|
def get_user_privileges(arguments = {})
|
39
47
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_privileges' }
|
@@ -28,14 +28,25 @@ module Elasticsearch
|
|
28
28
|
# Individual users and external applications should not call this API directly.
|
29
29
|
# Elastic reserves the right to change or remove this feature in future releases without prior notice.
|
30
30
|
#
|
31
|
-
# @option arguments [
|
32
|
-
# @option arguments [String] :data A comma-separated list of filters for the
|
33
|
-
# To return all content use
|
34
|
-
# To return a subset of content use
|
35
|
-
# By default returns no
|
31
|
+
# @option arguments [String, Array<String>] :uid A unique identifier for the user profile. (*Required*)
|
32
|
+
# @option arguments [String, Array<String>] :data A comma-separated list of filters for the `data` field of the profile document.
|
33
|
+
# To return all content use `data=*`.
|
34
|
+
# To return a subset of content use `data=<key>` to retrieve content nested under the specified `<key>`.
|
35
|
+
# By default returns no `data` content.
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
36
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
48
|
#
|
38
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
49
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-user-profile
|
39
50
|
#
|
40
51
|
def get_user_profile(arguments = {})
|
41
52
|
request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_profile' }
|
@@ -39,10 +39,25 @@ module Elasticsearch
|
|
39
39
|
# If applicable, it also returns expiration information for the API key in milliseconds.
|
40
40
|
# By default, API keys never expire. You can specify expiration information when you create the API keys.
|
41
41
|
#
|
42
|
+
# @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation
|
43
|
+
# visible to search.
|
44
|
+
# If 'wait_for', it waits for a refresh to make this operation visible to search.
|
45
|
+
# If 'false', nothing is done with refreshes. Server default: false.
|
46
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
47
|
+
# when they occur.
|
48
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
49
|
+
# returned by Elasticsearch.
|
50
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
51
|
+
# For example `"exists_time": "1h"` for humans and
|
52
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
53
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
54
|
+
# only by machines.
|
55
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
56
|
+
# this option for debugging only.
|
42
57
|
# @option arguments [Hash] :headers Custom HTTP headers
|
43
58
|
# @option arguments [Hash] :body request body
|
44
59
|
#
|
45
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
60
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-grant-api-key
|
46
61
|
#
|
47
62
|
def grant_api_key(arguments = {})
|
48
63
|
request_opts = { endpoint: arguments[:endpoint] || 'security.grant_api_key' }
|
@@ -56,7 +71,7 @@ module Elasticsearch
|
|
56
71
|
|
57
72
|
method = Elasticsearch::API::HTTP_POST
|
58
73
|
path = '_security/api_key/grant'
|
59
|
-
params =
|
74
|
+
params = Utils.process_params(arguments)
|
60
75
|
|
61
76
|
Elasticsearch::API::Response.new(
|
62
77
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -28,10 +28,21 @@ module Elasticsearch
|
|
28
28
|
# To check the privileges of other users, you must use the run as feature.
|
29
29
|
#
|
30
30
|
# @option arguments [String] :user Username
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
31
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
32
43
|
# @option arguments [Hash] :body request body
|
33
44
|
#
|
34
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges
|
35
46
|
#
|
36
47
|
def has_privileges(arguments = {})
|
37
48
|
request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges' }
|
@@ -56,7 +67,7 @@ module Elasticsearch
|
|
56
67
|
else
|
57
68
|
'_security/user/_has_privileges'
|
58
69
|
end
|
59
|
-
params =
|
70
|
+
params = Utils.process_params(arguments)
|
60
71
|
|
61
72
|
Elasticsearch::API::Response.new(
|
62
73
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -27,10 +27,21 @@ module Elasticsearch
|
|
27
27
|
# 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.
|
28
28
|
# Elastic reserves the right to change or remove this feature in future releases without prior notice.
|
29
29
|
#
|
30
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
31
|
+
# when they occur.
|
32
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
33
|
+
# returned by Elasticsearch.
|
34
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
35
|
+
# For example `"exists_time": "1h"` for humans and
|
36
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
37
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
38
|
+
# only by machines.
|
39
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
40
|
+
# this option for debugging only.
|
30
41
|
# @option arguments [Hash] :headers Custom HTTP headers
|
31
42
|
# @option arguments [Hash] :body request body
|
32
43
|
#
|
33
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
44
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-has-privileges-user-profile
|
34
45
|
#
|
35
46
|
def has_privileges_user_profile(arguments = {})
|
36
47
|
request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges_user_profile' }
|
@@ -44,7 +55,7 @@ module Elasticsearch
|
|
44
55
|
|
45
56
|
method = Elasticsearch::API::HTTP_POST
|
46
57
|
path = '_security/profile/_has_privileges'
|
47
|
-
params =
|
58
|
+
params = Utils.process_params(arguments)
|
48
59
|
|
49
60
|
Elasticsearch::API::Response.new(
|
50
61
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -25,19 +25,30 @@ module Elasticsearch
|
|
25
25
|
# Invalidate API keys.
|
26
26
|
# This API invalidates API keys created by the create API key or grant API key APIs.
|
27
27
|
# Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted.
|
28
|
-
# To use this API, you must have at least the
|
29
|
-
# The
|
30
|
-
# The
|
31
|
-
# The
|
32
|
-
# In addition, with the
|
33
|
-
# - Set the parameter
|
34
|
-
# - Or, set both
|
35
|
-
# - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the
|
28
|
+
# To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges.
|
29
|
+
# The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys.
|
30
|
+
# The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys.
|
31
|
+
# The `manage_own_api_key` only allows deleting REST API keys that are owned by the user.
|
32
|
+
# In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats:
|
33
|
+
# - Set the parameter `owner=true`.
|
34
|
+
# - Or, set both `username` and `realm_name` to match the user's identity.
|
35
|
+
# - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field.
|
36
36
|
#
|
37
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
38
|
+
# when they occur.
|
39
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
40
|
+
# returned by Elasticsearch.
|
41
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
42
|
+
# For example `"exists_time": "1h"` for humans and
|
43
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
44
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
45
|
+
# only by machines.
|
46
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
47
|
+
# this option for debugging only.
|
37
48
|
# @option arguments [Hash] :headers Custom HTTP headers
|
38
49
|
# @option arguments [Hash] :body request body
|
39
50
|
#
|
40
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
51
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-invalidate-api-key
|
41
52
|
#
|
42
53
|
def invalidate_api_key(arguments = {})
|
43
54
|
request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_api_key' }
|
@@ -51,7 +62,7 @@ module Elasticsearch
|
|
51
62
|
|
52
63
|
method = Elasticsearch::API::HTTP_DELETE
|
53
64
|
path = '_security/api_key'
|
54
|
-
params =
|
65
|
+
params = Utils.process_params(arguments)
|
55
66
|
|
56
67
|
Elasticsearch::API::Response.new(
|
57
68
|
perform_request(method, path, params, body, headers, request_opts)
|