@elastic/elasticsearch 8.16.2 → 9.0.0-alpha.1
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.
- package/catalog-info.yaml +4 -1
- package/lib/api/api/async_search.d.ts +16 -17
- package/lib/api/api/async_search.js +5 -16
- package/lib/api/api/async_search.js.map +1 -1
- package/lib/api/api/autoscaling.d.ts +16 -17
- package/lib/api/api/autoscaling.js +5 -7
- package/lib/api/api/autoscaling.js.map +1 -1
- package/lib/api/api/bulk.d.ts +4 -5
- package/lib/api/api/bulk.js +3 -5
- package/lib/api/api/bulk.js.map +1 -1
- package/lib/api/api/capabilities.d.ts +3 -4
- package/lib/api/api/capabilities.js +2 -2
- package/lib/api/api/capabilities.js.map +1 -1
- package/lib/api/api/cat.d.ts +121 -122
- package/lib/api/api/cat.js +26 -26
- package/lib/api/api/cat.js.map +1 -1
- package/lib/api/api/ccr.d.ts +52 -53
- package/lib/api/api/ccr.js +18 -54
- package/lib/api/api/ccr.js.map +1 -1
- package/lib/api/api/clear_scroll.d.ts +4 -5
- package/lib/api/api/clear_scroll.js +3 -12
- package/lib/api/api/clear_scroll.js.map +1 -1
- package/lib/api/api/close_point_in_time.d.ts +4 -5
- package/lib/api/api/close_point_in_time.js +3 -12
- package/lib/api/api/close_point_in_time.js.map +1 -1
- package/lib/api/api/cluster.d.ts +64 -65
- package/lib/api/api/cluster.js +20 -56
- package/lib/api/api/cluster.js.map +1 -1
- package/lib/api/api/connector.d.ts +132 -133
- package/lib/api/api/connector.js +50 -194
- package/lib/api/api/connector.js.map +1 -1
- package/lib/api/api/count.d.ts +5 -6
- package/lib/api/api/count.js +3 -12
- package/lib/api/api/count.js.map +1 -1
- package/lib/api/api/create.d.ts +4 -5
- package/lib/api/api/create.js +3 -5
- package/lib/api/api/create.js.map +1 -1
- package/lib/api/api/dangling_indices.d.ts +12 -13
- package/lib/api/api/dangling_indices.js +3 -3
- package/lib/api/api/dangling_indices.js.map +1 -1
- package/lib/api/api/delete.d.ts +4 -5
- package/lib/api/api/delete.js +2 -2
- package/lib/api/api/delete.js.map +1 -1
- package/lib/api/api/delete_by_query.d.ts +4 -5
- package/lib/api/api/delete_by_query.js +3 -12
- package/lib/api/api/delete_by_query.js.map +1 -1
- package/lib/api/api/delete_by_query_rethrottle.d.ts +4 -5
- package/lib/api/api/delete_by_query_rethrottle.js +2 -2
- package/lib/api/api/delete_by_query_rethrottle.js.map +1 -1
- package/lib/api/api/delete_script.d.ts +4 -5
- package/lib/api/api/delete_script.js +2 -2
- package/lib/api/api/delete_script.js.map +1 -1
- package/lib/api/api/enrich.d.ts +21 -22
- package/lib/api/api/enrich.js +6 -15
- package/lib/api/api/enrich.js.map +1 -1
- package/lib/api/api/eql.d.ts +20 -21
- package/lib/api/api/eql.js +6 -15
- package/lib/api/api/eql.js.map +1 -1
- package/lib/api/api/esql.d.ts +13 -14
- package/lib/api/api/esql.js +4 -13
- package/lib/api/api/esql.js.map +1 -1
- package/lib/api/api/exists.d.ts +4 -5
- package/lib/api/api/exists.js +2 -2
- package/lib/api/api/exists.js.map +1 -1
- package/lib/api/api/exists_source.d.ts +4 -5
- package/lib/api/api/exists_source.js +2 -2
- package/lib/api/api/exists_source.js.map +1 -1
- package/lib/api/api/explain.d.ts +4 -5
- package/lib/api/api/explain.js +3 -12
- package/lib/api/api/explain.js.map +1 -1
- package/lib/api/api/features.d.ts +8 -9
- package/lib/api/api/features.js +2 -2
- package/lib/api/api/features.js.map +1 -1
- package/lib/api/api/field_caps.d.ts +4 -5
- package/lib/api/api/field_caps.js +3 -12
- package/lib/api/api/field_caps.js.map +1 -1
- package/lib/api/api/fleet.d.ts +22 -23
- package/lib/api/api/fleet.js +8 -19
- package/lib/api/api/fleet.js.map +1 -1
- package/lib/api/api/get.d.ts +4 -5
- package/lib/api/api/get.js +2 -2
- package/lib/api/api/get.js.map +1 -1
- package/lib/api/api/get_script.d.ts +4 -5
- package/lib/api/api/get_script.js +2 -2
- package/lib/api/api/get_script.js.map +1 -1
- package/lib/api/api/get_script_context.d.ts +4 -5
- package/lib/api/api/get_script_context.js +2 -2
- package/lib/api/api/get_script_context.js.map +1 -1
- package/lib/api/api/get_script_languages.d.ts +4 -5
- package/lib/api/api/get_script_languages.js +2 -2
- package/lib/api/api/get_script_languages.js.map +1 -1
- package/lib/api/api/get_source.d.ts +4 -5
- package/lib/api/api/get_source.js +2 -2
- package/lib/api/api/get_source.js.map +1 -1
- package/lib/api/api/graph.d.ts +5 -6
- package/lib/api/api/graph.js +2 -11
- package/lib/api/api/graph.js.map +1 -1
- package/lib/api/api/health_report.d.ts +4 -5
- package/lib/api/api/health_report.js +2 -2
- package/lib/api/api/health_report.js.map +1 -1
- package/lib/api/api/ilm.d.ts +44 -45
- package/lib/api/api/ilm.js +14 -41
- package/lib/api/api/ilm.js.map +1 -1
- package/lib/api/api/index.d.ts +4 -5
- package/lib/api/api/index.js +3 -5
- package/lib/api/api/index.js.map +1 -1
- package/lib/api/api/indices.d.ts +238 -239
- package/lib/api/api/indices.js +77 -216
- package/lib/api/api/indices.js.map +1 -1
- package/lib/api/api/inference.d.ts +20 -21
- package/lib/api/api/inference.js +7 -18
- package/lib/api/api/inference.js.map +1 -1
- package/lib/api/api/info.d.ts +4 -5
- package/lib/api/api/info.js +2 -2
- package/lib/api/api/info.js.map +1 -1
- package/lib/api/api/ingest.d.ts +57 -58
- package/lib/api/api/ingest.js +15 -42
- package/lib/api/api/ingest.js.map +1 -1
- package/lib/api/api/knn_search.d.ts +4 -5
- package/lib/api/api/knn_search.js +3 -12
- package/lib/api/api/knn_search.js.map +1 -1
- package/lib/api/api/license.d.ts +28 -29
- package/lib/api/api/license.js +8 -17
- package/lib/api/api/license.js.map +1 -1
- package/lib/api/api/logstash.d.ts +12 -13
- package/lib/api/api/logstash.js +4 -6
- package/lib/api/api/logstash.js.map +1 -1
- package/lib/api/api/mget.d.ts +4 -5
- package/lib/api/api/mget.js +3 -12
- package/lib/api/api/mget.js.map +1 -1
- package/lib/api/api/migration.d.ts +12 -13
- package/lib/api/api/migration.js +3 -3
- package/lib/api/api/migration.js.map +1 -1
- package/lib/api/api/ml.d.ts +293 -294
- package/lib/api/api/ml.js +112 -449
- package/lib/api/api/ml.js.map +1 -1
- package/lib/api/api/monitoring.d.ts +4 -5
- package/lib/api/api/monitoring.js +2 -4
- package/lib/api/api/monitoring.js.map +1 -1
- package/lib/api/api/msearch.d.ts +4 -5
- package/lib/api/api/msearch.js +3 -5
- package/lib/api/api/msearch.js.map +1 -1
- package/lib/api/api/msearch_template.d.ts +4 -5
- package/lib/api/api/msearch_template.js +3 -5
- package/lib/api/api/msearch_template.js.map +1 -1
- package/lib/api/api/mtermvectors.d.ts +4 -5
- package/lib/api/api/mtermvectors.js +3 -12
- package/lib/api/api/mtermvectors.js.map +1 -1
- package/lib/api/api/nodes.d.ts +28 -29
- package/lib/api/api/nodes.js +8 -17
- package/lib/api/api/nodes.js.map +1 -1
- package/lib/api/api/open_point_in_time.d.ts +4 -5
- package/lib/api/api/open_point_in_time.js +3 -12
- package/lib/api/api/open_point_in_time.js.map +1 -1
- package/lib/api/api/ping.d.ts +4 -5
- package/lib/api/api/ping.js +2 -2
- package/lib/api/api/ping.js.map +1 -1
- package/lib/api/api/profiling.d.ts +16 -17
- package/lib/api/api/profiling.js +4 -4
- package/lib/api/api/profiling.js.map +1 -1
- package/lib/api/api/put_script.d.ts +4 -5
- package/lib/api/api/put_script.js +3 -12
- package/lib/api/api/put_script.js.map +1 -1
- package/lib/api/api/query_rules.d.ts +40 -41
- package/lib/api/api/query_rules.js +11 -38
- package/lib/api/api/query_rules.js.map +1 -1
- package/lib/api/api/rank_eval.d.ts +4 -5
- package/lib/api/api/rank_eval.js +3 -12
- package/lib/api/api/rank_eval.js.map +1 -1
- package/lib/api/api/reindex.d.ts +4 -5
- package/lib/api/api/reindex.js +3 -12
- package/lib/api/api/reindex.js.map +1 -1
- package/lib/api/api/reindex_rethrottle.d.ts +4 -5
- package/lib/api/api/reindex_rethrottle.js +2 -2
- package/lib/api/api/reindex_rethrottle.js.map +1 -1
- package/lib/api/api/render_search_template.d.ts +4 -5
- package/lib/api/api/render_search_template.js +3 -12
- package/lib/api/api/render_search_template.js.map +1 -1
- package/lib/api/api/rollup.d.ts +32 -33
- package/lib/api/api/rollup.js +10 -28
- package/lib/api/api/rollup.js.map +1 -1
- package/lib/api/api/scripts_painless_execute.d.ts +4 -5
- package/lib/api/api/scripts_painless_execute.js +3 -12
- package/lib/api/api/scripts_painless_execute.js.map +1 -1
- package/lib/api/api/scroll.d.ts +4 -5
- package/lib/api/api/scroll.js +3 -12
- package/lib/api/api/scroll.js.map +1 -1
- package/lib/api/api/search.d.ts +4 -5
- package/lib/api/api/search.js +3 -14
- package/lib/api/api/search.js.map +1 -1
- package/lib/api/api/search_application.d.ts +39 -40
- package/lib/api/api/search_application.js +12 -23
- package/lib/api/api/search_application.js.map +1 -1
- package/lib/api/api/search_mvt.d.ts +4 -5
- package/lib/api/api/search_mvt.js +3 -12
- package/lib/api/api/search_mvt.js.map +1 -1
- package/lib/api/api/search_shards.d.ts +4 -5
- package/lib/api/api/search_shards.js +2 -2
- package/lib/api/api/search_shards.js.map +1 -1
- package/lib/api/api/search_template.d.ts +4 -5
- package/lib/api/api/search_template.js +3 -12
- package/lib/api/api/search_template.js.map +1 -1
- package/lib/api/api/searchable_snapshots.d.ts +16 -17
- package/lib/api/api/searchable_snapshots.js +5 -14
- package/lib/api/api/searchable_snapshots.js.map +1 -1
- package/lib/api/api/security.d.ts +253 -254
- package/lib/api/api/security.js +92 -337
- package/lib/api/api/security.js.map +1 -1
- package/lib/api/api/shutdown.d.ts +9 -10
- package/lib/api/api/shutdown.js +4 -13
- package/lib/api/api/shutdown.js.map +1 -1
- package/lib/api/api/simulate.d.ts +4 -5
- package/lib/api/api/simulate.js +1 -1
- package/lib/api/api/simulate.js.map +1 -1
- package/lib/api/api/slm.d.ts +36 -37
- package/lib/api/api/slm.js +10 -19
- package/lib/api/api/slm.js.map +1 -1
- package/lib/api/api/snapshot.d.ts +52 -53
- package/lib/api/api/snapshot.js +17 -46
- package/lib/api/api/snapshot.js.map +1 -1
- package/lib/api/api/sql.d.ts +30 -31
- package/lib/api/api/sql.js +9 -36
- package/lib/api/api/sql.js.map +1 -1
- package/lib/api/api/ssl.d.ts +4 -5
- package/lib/api/api/ssl.js +1 -1
- package/lib/api/api/ssl.js.map +1 -1
- package/lib/api/api/synonyms.d.ts +35 -36
- package/lib/api/api/synonyms.js +9 -27
- package/lib/api/api/synonyms.js.map +1 -1
- package/lib/api/api/tasks.d.ts +12 -13
- package/lib/api/api/tasks.js +3 -3
- package/lib/api/api/tasks.js.map +1 -1
- package/lib/api/api/terms_enum.d.ts +4 -5
- package/lib/api/api/terms_enum.js +3 -12
- package/lib/api/api/terms_enum.js.map +1 -1
- package/lib/api/api/termvectors.d.ts +4 -5
- package/lib/api/api/termvectors.js +3 -12
- package/lib/api/api/termvectors.js.map +1 -1
- package/lib/api/api/text_structure.d.ts +16 -17
- package/lib/api/api/text_structure.js +6 -17
- package/lib/api/api/text_structure.js.map +1 -1
- package/lib/api/api/transform.d.ts +48 -49
- package/lib/api/api/transform.js +15 -42
- package/lib/api/api/transform.js.map +1 -1
- package/lib/api/api/update.d.ts +4 -5
- package/lib/api/api/update.js +3 -12
- package/lib/api/api/update.js.map +1 -1
- package/lib/api/api/update_by_query.d.ts +4 -5
- package/lib/api/api/update_by_query.js +3 -12
- package/lib/api/api/update_by_query.js.map +1 -1
- package/lib/api/api/update_by_query_rethrottle.d.ts +4 -5
- package/lib/api/api/update_by_query_rethrottle.js +2 -2
- package/lib/api/api/update_by_query_rethrottle.js.map +1 -1
- package/lib/api/api/watcher.d.ts +52 -53
- package/lib/api/api/watcher.js +16 -43
- package/lib/api/api/watcher.js.map +1 -1
- package/lib/api/api/xpack.d.ts +8 -9
- package/lib/api/api/xpack.js +2 -2
- package/lib/api/api/xpack.js.map +1 -1
- package/lib/api/index.js +1 -1
- package/lib/api/index.js.map +1 -1
- package/lib/api/types.d.ts +131 -72
- package/lib/client.d.ts +82 -2
- package/lib/client.js +11 -4
- package/lib/client.js.map +1 -1
- package/lib/helpers.d.ts +0 -3
- package/lib/helpers.js +8 -7
- package/lib/helpers.js.map +1 -1
- package/package.json +33 -33
- package/renovate.json +29 -0
- package/lib/api/typesWithBodyKey.d.ts +0 -18163
- package/lib/api/typesWithBodyKey.js +0 -21
- package/lib/api/typesWithBodyKey.js.map +0 -1
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Transport, TransportRequestOptions, TransportRequestOptionsWithMeta, TransportRequestOptionsWithOutMeta, TransportResult } from '@elastic/transport';
|
|
2
2
|
import * as T from '../types';
|
|
3
|
-
import * as TB from '../typesWithBodyKey';
|
|
4
3
|
interface That {
|
|
5
4
|
transport: Transport;
|
|
6
5
|
}
|
|
@@ -9,444 +8,444 @@ export default class Security {
|
|
|
9
8
|
constructor(transport: Transport);
|
|
10
9
|
/**
|
|
11
10
|
* Activate a user profile. Create or update a user profile on behalf of another user.
|
|
12
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
11
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-activate-user-profile.html | Elasticsearch API documentation}
|
|
13
12
|
*/
|
|
14
|
-
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest
|
|
15
|
-
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest
|
|
16
|
-
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest
|
|
13
|
+
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>;
|
|
14
|
+
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>;
|
|
15
|
+
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>;
|
|
17
16
|
/**
|
|
18
17
|
* Authenticate a user. Authenticates a user and returns information about the authenticated user. Include the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication). A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. If the user cannot be authenticated, this API returns a 401 status code.
|
|
19
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
18
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-authenticate.html | Elasticsearch API documentation}
|
|
20
19
|
*/
|
|
21
|
-
authenticate(this: That, params?: T.SecurityAuthenticateRequest
|
|
22
|
-
authenticate(this: That, params?: T.SecurityAuthenticateRequest
|
|
23
|
-
authenticate(this: That, params?: T.SecurityAuthenticateRequest
|
|
20
|
+
authenticate(this: That, params?: T.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityAuthenticateResponse>;
|
|
21
|
+
authenticate(this: That, params?: T.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityAuthenticateResponse, unknown>>;
|
|
22
|
+
authenticate(this: That, params?: T.SecurityAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecurityAuthenticateResponse>;
|
|
24
23
|
/**
|
|
25
24
|
* Bulk delete roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk delete roles API cannot delete roles that are defined in roles files.
|
|
26
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
25
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-bulk-delete-role.html | Elasticsearch API documentation}
|
|
27
26
|
*/
|
|
28
|
-
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest
|
|
29
|
-
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest
|
|
30
|
-
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest
|
|
27
|
+
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkDeleteRoleResponse>;
|
|
28
|
+
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkDeleteRoleResponse, unknown>>;
|
|
29
|
+
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkDeleteRoleResponse>;
|
|
31
30
|
/**
|
|
32
31
|
* Bulk create or update roles. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The bulk create or update roles API cannot update roles that are defined in roles files.
|
|
33
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
32
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-bulk-put-role.html | Elasticsearch API documentation}
|
|
34
33
|
*/
|
|
35
|
-
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest
|
|
36
|
-
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest
|
|
37
|
-
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest
|
|
34
|
+
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkPutRoleResponse>;
|
|
35
|
+
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkPutRoleResponse, unknown>>;
|
|
36
|
+
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkPutRoleResponse>;
|
|
38
37
|
/**
|
|
39
38
|
* Updates the attributes of multiple existing API keys.
|
|
40
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
39
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
|
|
41
40
|
*/
|
|
42
|
-
bulkUpdateApiKeys(this: That, params?: T.TODO
|
|
43
|
-
bulkUpdateApiKeys(this: That, params?: T.TODO
|
|
44
|
-
bulkUpdateApiKeys(this: That, params?: T.TODO
|
|
41
|
+
bulkUpdateApiKeys(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
42
|
+
bulkUpdateApiKeys(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
43
|
+
bulkUpdateApiKeys(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
45
44
|
/**
|
|
46
45
|
* Change passwords. Change the passwords of users in the native realm and built-in users.
|
|
47
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
46
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-change-password.html | Elasticsearch API documentation}
|
|
48
47
|
*/
|
|
49
|
-
changePassword(this: That, params?: T.SecurityChangePasswordRequest
|
|
50
|
-
changePassword(this: That, params?: T.SecurityChangePasswordRequest
|
|
51
|
-
changePassword(this: That, params?: T.SecurityChangePasswordRequest
|
|
48
|
+
changePassword(this: That, params?: T.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>;
|
|
49
|
+
changePassword(this: That, params?: T.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityChangePasswordResponse, unknown>>;
|
|
50
|
+
changePassword(this: That, params?: T.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise<T.SecurityChangePasswordResponse>;
|
|
52
51
|
/**
|
|
53
52
|
* Clear the API key cache. Evict a subset of all entries from the API key cache. The cache is also automatically cleared on state changes of the security index.
|
|
54
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
53
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
|
|
55
54
|
*/
|
|
56
|
-
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest
|
|
57
|
-
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest
|
|
58
|
-
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest
|
|
55
|
+
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
56
|
+
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearApiKeyCacheResponse, unknown>>;
|
|
57
|
+
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
59
58
|
/**
|
|
60
59
|
* Clear the privileges cache. Evict privileges from the native application privilege cache. The cache is also automatically cleared for applications that have their privileges updated.
|
|
61
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
60
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
|
|
62
61
|
*/
|
|
63
|
-
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest
|
|
64
|
-
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest
|
|
65
|
-
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest
|
|
62
|
+
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
63
|
+
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedPrivilegesResponse, unknown>>;
|
|
64
|
+
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
66
65
|
/**
|
|
67
66
|
* Clear the user cache. Evict users from the user cache. You can completely clear the cache or evict specific users.
|
|
68
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
67
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-cache.html | Elasticsearch API documentation}
|
|
69
68
|
*/
|
|
70
|
-
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest
|
|
71
|
-
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest
|
|
72
|
-
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest
|
|
69
|
+
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
70
|
+
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRealmsResponse, unknown>>;
|
|
71
|
+
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
73
72
|
/**
|
|
74
73
|
* Clear the roles cache. Evict roles from the native role cache.
|
|
75
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
74
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-role-cache.html | Elasticsearch API documentation}
|
|
76
75
|
*/
|
|
77
|
-
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest
|
|
78
|
-
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest
|
|
79
|
-
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest
|
|
76
|
+
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>;
|
|
77
|
+
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRolesResponse, unknown>>;
|
|
78
|
+
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRolesResponse>;
|
|
80
79
|
/**
|
|
81
80
|
* Clear service account token caches. Evict a subset of all entries from the service account token caches.
|
|
82
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
81
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
|
|
83
82
|
*/
|
|
84
|
-
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest
|
|
85
|
-
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest
|
|
86
|
-
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest
|
|
83
|
+
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
84
|
+
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedServiceTokensResponse, unknown>>;
|
|
85
|
+
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
87
86
|
/**
|
|
88
87
|
* Create an API key. Create an API key for access without requiring basic authentication. 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.
|
|
89
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
88
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-api-key.html | Elasticsearch API documentation}
|
|
90
89
|
*/
|
|
91
|
-
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest
|
|
92
|
-
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest
|
|
93
|
-
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest
|
|
90
|
+
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>;
|
|
91
|
+
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateApiKeyResponse, unknown>>;
|
|
92
|
+
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateApiKeyResponse>;
|
|
94
93
|
/**
|
|
95
94
|
* 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.
|
|
96
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
95
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
97
96
|
*/
|
|
98
|
-
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest
|
|
99
|
-
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest
|
|
100
|
-
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest
|
|
97
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateCrossClusterApiKeyResponse>;
|
|
98
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateCrossClusterApiKeyResponse, unknown>>;
|
|
99
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateCrossClusterApiKeyResponse>;
|
|
101
100
|
/**
|
|
102
101
|
* Create a service account token. Create a service accounts token for access without requiring basic authentication.
|
|
103
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
102
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-create-service-token.html | Elasticsearch API documentation}
|
|
104
103
|
*/
|
|
105
|
-
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest
|
|
106
|
-
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest
|
|
107
|
-
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest
|
|
104
|
+
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
105
|
+
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateServiceTokenResponse, unknown>>;
|
|
106
|
+
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
108
107
|
/**
|
|
109
108
|
* Delete application privileges.
|
|
110
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
109
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-privilege.html | Elasticsearch API documentation}
|
|
111
110
|
*/
|
|
112
|
-
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest
|
|
113
|
-
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest
|
|
114
|
-
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest
|
|
111
|
+
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
112
|
+
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeletePrivilegesResponse, unknown>>;
|
|
113
|
+
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
115
114
|
/**
|
|
116
115
|
* Delete roles. Delete roles in the native realm.
|
|
117
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
116
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-role.html | Elasticsearch API documentation}
|
|
118
117
|
*/
|
|
119
|
-
deleteRole(this: That, params: T.SecurityDeleteRoleRequest
|
|
120
|
-
deleteRole(this: That, params: T.SecurityDeleteRoleRequest
|
|
121
|
-
deleteRole(this: That, params: T.SecurityDeleteRoleRequest
|
|
118
|
+
deleteRole(this: That, params: T.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>;
|
|
119
|
+
deleteRole(this: That, params: T.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleResponse, unknown>>;
|
|
120
|
+
deleteRole(this: That, params: T.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleResponse>;
|
|
122
121
|
/**
|
|
123
122
|
* Delete role mappings.
|
|
124
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
123
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-role-mapping.html | Elasticsearch API documentation}
|
|
125
124
|
*/
|
|
126
|
-
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest
|
|
127
|
-
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest
|
|
128
|
-
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest
|
|
125
|
+
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
126
|
+
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleMappingResponse, unknown>>;
|
|
127
|
+
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
129
128
|
/**
|
|
130
129
|
* Delete service account tokens. Delete service account tokens for a service in a specified namespace.
|
|
131
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
130
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-service-token.html | Elasticsearch API documentation}
|
|
132
131
|
*/
|
|
133
|
-
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest
|
|
134
|
-
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest
|
|
135
|
-
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest
|
|
132
|
+
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
133
|
+
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteServiceTokenResponse, unknown>>;
|
|
134
|
+
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
136
135
|
/**
|
|
137
136
|
* Delete users. Delete users from the native realm.
|
|
138
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
137
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-delete-user.html | Elasticsearch API documentation}
|
|
139
138
|
*/
|
|
140
|
-
deleteUser(this: That, params: T.SecurityDeleteUserRequest
|
|
141
|
-
deleteUser(this: That, params: T.SecurityDeleteUserRequest
|
|
142
|
-
deleteUser(this: That, params: T.SecurityDeleteUserRequest
|
|
139
|
+
deleteUser(this: That, params: T.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>;
|
|
140
|
+
deleteUser(this: That, params: T.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteUserResponse, unknown>>;
|
|
141
|
+
deleteUser(this: That, params: T.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteUserResponse>;
|
|
143
142
|
/**
|
|
144
143
|
* Disable users. Disable users in the native realm.
|
|
145
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
144
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user.html | Elasticsearch API documentation}
|
|
146
145
|
*/
|
|
147
|
-
disableUser(this: That, params: T.SecurityDisableUserRequest
|
|
148
|
-
disableUser(this: That, params: T.SecurityDisableUserRequest
|
|
149
|
-
disableUser(this: That, params: T.SecurityDisableUserRequest
|
|
146
|
+
disableUser(this: That, params: T.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>;
|
|
147
|
+
disableUser(this: That, params: T.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserResponse, unknown>>;
|
|
148
|
+
disableUser(this: That, params: T.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserResponse>;
|
|
150
149
|
/**
|
|
151
150
|
* Disable a user profile. Disable user profiles so that they are not visible in user profile searches.
|
|
152
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
151
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-disable-user-profile.html | Elasticsearch API documentation}
|
|
153
152
|
*/
|
|
154
|
-
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest
|
|
155
|
-
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest
|
|
156
|
-
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest
|
|
153
|
+
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>;
|
|
154
|
+
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>;
|
|
155
|
+
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>;
|
|
157
156
|
/**
|
|
158
157
|
* Enable users. Enable users in the native realm.
|
|
159
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
158
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user.html | Elasticsearch API documentation}
|
|
160
159
|
*/
|
|
161
|
-
enableUser(this: That, params: T.SecurityEnableUserRequest
|
|
162
|
-
enableUser(this: That, params: T.SecurityEnableUserRequest
|
|
163
|
-
enableUser(this: That, params: T.SecurityEnableUserRequest
|
|
160
|
+
enableUser(this: That, params: T.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>;
|
|
161
|
+
enableUser(this: That, params: T.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserResponse, unknown>>;
|
|
162
|
+
enableUser(this: That, params: T.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserResponse>;
|
|
164
163
|
/**
|
|
165
164
|
* Enable a user profile. Enable user profiles to make them visible in user profile searches.
|
|
166
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
165
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-enable-user-profile.html | Elasticsearch API documentation}
|
|
167
166
|
*/
|
|
168
|
-
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest
|
|
169
|
-
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest
|
|
170
|
-
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest
|
|
167
|
+
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>;
|
|
168
|
+
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>;
|
|
169
|
+
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>;
|
|
171
170
|
/**
|
|
172
171
|
* Enroll Kibana. Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster.
|
|
173
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
172
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-kibana-enrollment.html | Elasticsearch API documentation}
|
|
174
173
|
*/
|
|
175
|
-
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest
|
|
176
|
-
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest
|
|
177
|
-
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest
|
|
174
|
+
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>;
|
|
175
|
+
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollKibanaResponse, unknown>>;
|
|
176
|
+
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollKibanaResponse>;
|
|
178
177
|
/**
|
|
179
178
|
* Enroll a node. Enroll a new node to allow it to join an existing cluster with security features enabled.
|
|
180
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
179
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-node-enrollment.html | Elasticsearch API documentation}
|
|
181
180
|
*/
|
|
182
|
-
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest
|
|
183
|
-
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest
|
|
184
|
-
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest
|
|
181
|
+
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>;
|
|
182
|
+
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollNodeResponse, unknown>>;
|
|
183
|
+
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollNodeResponse>;
|
|
185
184
|
/**
|
|
186
185
|
* Get API key information. Retrieves information for one or more API keys. NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
|
|
187
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
186
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-api-key.html | Elasticsearch API documentation}
|
|
188
187
|
*/
|
|
189
|
-
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest
|
|
190
|
-
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest
|
|
191
|
-
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest
|
|
188
|
+
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>;
|
|
189
|
+
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetApiKeyResponse, unknown>>;
|
|
190
|
+
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGetApiKeyResponse>;
|
|
192
191
|
/**
|
|
193
192
|
* Get builtin privileges. Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
|
|
194
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
193
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
|
|
195
194
|
*/
|
|
196
|
-
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest
|
|
197
|
-
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest
|
|
198
|
-
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest
|
|
195
|
+
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
196
|
+
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetBuiltinPrivilegesResponse, unknown>>;
|
|
197
|
+
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
199
198
|
/**
|
|
200
199
|
* Get application privileges.
|
|
201
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
200
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-privileges.html | Elasticsearch API documentation}
|
|
202
201
|
*/
|
|
203
|
-
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest
|
|
204
|
-
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest
|
|
205
|
-
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest
|
|
202
|
+
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>;
|
|
203
|
+
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetPrivilegesResponse, unknown>>;
|
|
204
|
+
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetPrivilegesResponse>;
|
|
206
205
|
/**
|
|
207
|
-
* Get roles. Get roles in the native realm.
|
|
208
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
206
|
+
* Get roles. Get roles in the native realm.
|
|
207
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-role.html | Elasticsearch API documentation}
|
|
209
208
|
*/
|
|
210
|
-
getRole(this: That, params?: T.SecurityGetRoleRequest
|
|
211
|
-
getRole(this: That, params?: T.SecurityGetRoleRequest
|
|
212
|
-
getRole(this: That, params?: T.SecurityGetRoleRequest
|
|
209
|
+
getRole(this: That, params?: T.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>;
|
|
210
|
+
getRole(this: That, params?: T.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleResponse, unknown>>;
|
|
211
|
+
getRole(this: That, params?: T.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleResponse>;
|
|
213
212
|
/**
|
|
214
213
|
* Get 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 get role mappings API cannot retrieve role mappings that are defined in role mapping files.
|
|
215
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
214
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-role-mapping.html | Elasticsearch API documentation}
|
|
216
215
|
*/
|
|
217
|
-
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest
|
|
218
|
-
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest
|
|
219
|
-
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest
|
|
216
|
+
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>;
|
|
217
|
+
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleMappingResponse, unknown>>;
|
|
218
|
+
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleMappingResponse>;
|
|
220
219
|
/**
|
|
221
220
|
* Get service accounts. Get a list of service accounts that match the provided path parameters.
|
|
222
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
221
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-service-accounts.html | Elasticsearch API documentation}
|
|
223
222
|
*/
|
|
224
|
-
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest
|
|
225
|
-
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest
|
|
226
|
-
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest
|
|
223
|
+
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
224
|
+
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceAccountsResponse, unknown>>;
|
|
225
|
+
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
227
226
|
/**
|
|
228
227
|
* Get service account credentials.
|
|
229
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
228
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-service-credentials.html | Elasticsearch API documentation}
|
|
230
229
|
*/
|
|
231
|
-
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest
|
|
232
|
-
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest
|
|
233
|
-
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest
|
|
230
|
+
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
231
|
+
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceCredentialsResponse, unknown>>;
|
|
232
|
+
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
234
233
|
/**
|
|
235
234
|
* Retrieve settings for the security system indices
|
|
236
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
235
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-settings.html | Elasticsearch API documentation}
|
|
237
236
|
*/
|
|
238
|
-
getSettings(this: That, params?: T.TODO
|
|
239
|
-
getSettings(this: That, params?: T.TODO
|
|
240
|
-
getSettings(this: That, params?: T.TODO
|
|
237
|
+
getSettings(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
238
|
+
getSettings(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
239
|
+
getSettings(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
241
240
|
/**
|
|
242
241
|
* Get a token. Create a bearer token for access without requiring basic authentication.
|
|
243
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
242
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-token.html | Elasticsearch API documentation}
|
|
244
243
|
*/
|
|
245
|
-
getToken(this: That, params?: T.SecurityGetTokenRequest
|
|
246
|
-
getToken(this: That, params?: T.SecurityGetTokenRequest
|
|
247
|
-
getToken(this: That, params?: T.SecurityGetTokenRequest
|
|
244
|
+
getToken(this: That, params?: T.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>;
|
|
245
|
+
getToken(this: That, params?: T.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetTokenResponse, unknown>>;
|
|
246
|
+
getToken(this: That, params?: T.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityGetTokenResponse>;
|
|
248
247
|
/**
|
|
249
248
|
* Get users. Get information about users in the native realm and built-in users.
|
|
250
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
249
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user.html | Elasticsearch API documentation}
|
|
251
250
|
*/
|
|
252
|
-
getUser(this: That, params?: T.SecurityGetUserRequest
|
|
253
|
-
getUser(this: That, params?: T.SecurityGetUserRequest
|
|
254
|
-
getUser(this: That, params?: T.SecurityGetUserRequest
|
|
251
|
+
getUser(this: That, params?: T.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>;
|
|
252
|
+
getUser(this: That, params?: T.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserResponse, unknown>>;
|
|
253
|
+
getUser(this: That, params?: T.SecurityGetUserRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserResponse>;
|
|
255
254
|
/**
|
|
256
255
|
* Get user privileges.
|
|
257
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
256
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user-privileges.html | Elasticsearch API documentation}
|
|
258
257
|
*/
|
|
259
|
-
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest
|
|
260
|
-
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest
|
|
261
|
-
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest
|
|
258
|
+
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
259
|
+
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserPrivilegesResponse, unknown>>;
|
|
260
|
+
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
262
261
|
/**
|
|
263
262
|
* Get a user profile. Get a user's profile using the unique profile ID.
|
|
264
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
263
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-user-profile.html | Elasticsearch API documentation}
|
|
265
264
|
*/
|
|
266
|
-
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest
|
|
267
|
-
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest
|
|
268
|
-
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest
|
|
265
|
+
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>;
|
|
266
|
+
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>;
|
|
267
|
+
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>;
|
|
269
268
|
/**
|
|
270
269
|
* Grant an API key. Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials (either an access token, or a username and password) for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user’s credentials. The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user. This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. A successful grant API key API call 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.
|
|
271
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
270
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-grant-api-key.html | Elasticsearch API documentation}
|
|
272
271
|
*/
|
|
273
|
-
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest
|
|
274
|
-
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest
|
|
275
|
-
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest
|
|
272
|
+
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>;
|
|
273
|
+
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGrantApiKeyResponse, unknown>>;
|
|
274
|
+
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGrantApiKeyResponse>;
|
|
276
275
|
/**
|
|
277
276
|
* Check user privileges. Determine whether the specified user has a specified list of privileges.
|
|
278
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
277
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-has-privileges.html | Elasticsearch API documentation}
|
|
279
278
|
*/
|
|
280
|
-
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest
|
|
281
|
-
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest
|
|
282
|
-
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest
|
|
279
|
+
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>;
|
|
280
|
+
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesResponse, unknown>>;
|
|
281
|
+
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesResponse>;
|
|
283
282
|
/**
|
|
284
283
|
* Check user profile privileges. Determine whether the users associated with the specified user profile IDs have all the requested privileges.
|
|
285
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
284
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
|
|
286
285
|
*/
|
|
287
|
-
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest
|
|
288
|
-
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest
|
|
289
|
-
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest
|
|
286
|
+
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
287
|
+
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesUserProfileResponse, unknown>>;
|
|
288
|
+
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
290
289
|
/**
|
|
291
290
|
* Invalidate API keys. This API invalidates API keys created by the create API key or grant API key APIs. 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. The `manage_api_key` privilege allows deleting any API keys. The `manage_own_api_key` only allows deleting API keys that are owned by the user. In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: - Set the parameter `owner=true`. - Or, set both `username` and `realm_name` to match the user’s identity. - 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.
|
|
292
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
291
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-invalidate-api-key.html | Elasticsearch API documentation}
|
|
293
292
|
*/
|
|
294
|
-
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest
|
|
295
|
-
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest
|
|
296
|
-
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest
|
|
293
|
+
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
294
|
+
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateApiKeyResponse, unknown>>;
|
|
295
|
+
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
297
296
|
/**
|
|
298
297
|
* Invalidate a token. The access tokens returned by the get token API have a finite period of time for which they are valid. After that time period, they can no longer be used. The time period is defined by the `xpack.security.authc.token.timeout` setting. The refresh tokens returned by the get token API are only valid for 24 hours. They can also be used exactly once. If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API.
|
|
299
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
298
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-invalidate-token.html | Elasticsearch API documentation}
|
|
300
299
|
*/
|
|
301
|
-
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest
|
|
302
|
-
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest
|
|
303
|
-
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest
|
|
300
|
+
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>;
|
|
301
|
+
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateTokenResponse, unknown>>;
|
|
302
|
+
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateTokenResponse>;
|
|
304
303
|
/**
|
|
305
304
|
* Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
|
|
306
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
305
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-oidc-authenticate.html | Elasticsearch API documentation}
|
|
307
306
|
*/
|
|
308
|
-
oidcAuthenticate(this: That, params?: T.TODO
|
|
309
|
-
oidcAuthenticate(this: That, params?: T.TODO
|
|
310
|
-
oidcAuthenticate(this: That, params?: T.TODO
|
|
307
|
+
oidcAuthenticate(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
308
|
+
oidcAuthenticate(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
309
|
+
oidcAuthenticate(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
311
310
|
/**
|
|
312
311
|
* Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
|
|
313
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
312
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-oidc-logout.html | Elasticsearch API documentation}
|
|
314
313
|
*/
|
|
315
|
-
oidcLogout(this: That, params?: T.TODO
|
|
316
|
-
oidcLogout(this: That, params?: T.TODO
|
|
317
|
-
oidcLogout(this: That, params?: T.TODO
|
|
314
|
+
oidcLogout(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
315
|
+
oidcLogout(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
316
|
+
oidcLogout(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
318
317
|
/**
|
|
319
318
|
* Creates an OAuth 2.0 authentication request as a URL string
|
|
320
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
319
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
|
|
321
320
|
*/
|
|
322
|
-
oidcPrepareAuthentication(this: That, params?: T.TODO
|
|
323
|
-
oidcPrepareAuthentication(this: That, params?: T.TODO
|
|
324
|
-
oidcPrepareAuthentication(this: That, params?: T.TODO
|
|
321
|
+
oidcPrepareAuthentication(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
322
|
+
oidcPrepareAuthentication(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
323
|
+
oidcPrepareAuthentication(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
325
324
|
/**
|
|
326
325
|
* Create or update application privileges.
|
|
327
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
326
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-privileges.html | Elasticsearch API documentation}
|
|
328
327
|
*/
|
|
329
|
-
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest
|
|
330
|
-
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest
|
|
331
|
-
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest
|
|
328
|
+
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>;
|
|
329
|
+
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutPrivilegesResponse, unknown>>;
|
|
330
|
+
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityPutPrivilegesResponse>;
|
|
332
331
|
/**
|
|
333
332
|
* Create or update roles. The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files. File-based role management is not available in Elastic Serverless.
|
|
334
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
333
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-role.html | Elasticsearch API documentation}
|
|
335
334
|
*/
|
|
336
|
-
putRole(this: That, params: T.SecurityPutRoleRequest
|
|
337
|
-
putRole(this: That, params: T.SecurityPutRoleRequest
|
|
338
|
-
putRole(this: That, params: T.SecurityPutRoleRequest
|
|
335
|
+
putRole(this: That, params: T.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>;
|
|
336
|
+
putRole(this: That, params: T.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleResponse, unknown>>;
|
|
337
|
+
putRole(this: That, params: T.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleResponse>;
|
|
339
338
|
/**
|
|
340
339
|
* Create or update role mappings. Role mappings define which roles are assigned to each user. Each mapping has rules that identify users and a list of roles that are granted to those users. The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. This API does not create roles. Rather, it maps users to existing roles. Roles can be created by using the create or update roles API or roles files.
|
|
341
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
340
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-role-mapping.html | Elasticsearch API documentation}
|
|
342
341
|
*/
|
|
343
|
-
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest
|
|
344
|
-
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest
|
|
345
|
-
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest
|
|
342
|
+
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>;
|
|
343
|
+
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleMappingResponse, unknown>>;
|
|
344
|
+
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>;
|
|
346
345
|
/**
|
|
347
346
|
* Create or update users. A password is required for adding a new user but is optional when updating an existing user. To change a user’s password without updating any other fields, use the change password API.
|
|
348
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
347
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-put-user.html | Elasticsearch API documentation}
|
|
349
348
|
*/
|
|
350
|
-
putUser(this: That, params: T.SecurityPutUserRequest
|
|
351
|
-
putUser(this: That, params: T.SecurityPutUserRequest
|
|
352
|
-
putUser(this: That, params: T.SecurityPutUserRequest
|
|
349
|
+
putUser(this: That, params: T.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>;
|
|
350
|
+
putUser(this: That, params: T.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutUserResponse, unknown>>;
|
|
351
|
+
putUser(this: That, params: T.SecurityPutUserRequest, options?: TransportRequestOptions): Promise<T.SecurityPutUserResponse>;
|
|
353
352
|
/**
|
|
354
353
|
* Find API keys with a query. Get a paginated list of API keys and their information. You can optionally filter the results with a query.
|
|
355
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
354
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-api-key.html | Elasticsearch API documentation}
|
|
356
355
|
*/
|
|
357
|
-
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest
|
|
358
|
-
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest
|
|
359
|
-
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest
|
|
356
|
+
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>;
|
|
357
|
+
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryApiKeysResponse, unknown>>;
|
|
358
|
+
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryApiKeysResponse>;
|
|
360
359
|
/**
|
|
361
360
|
* Find roles with a query. Get roles in a paginated manner. You can optionally filter the results with a query.
|
|
362
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
361
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-role.html | Elasticsearch API documentation}
|
|
363
362
|
*/
|
|
364
|
-
queryRole(this: That, params?: T.SecurityQueryRoleRequest
|
|
365
|
-
queryRole(this: That, params?: T.SecurityQueryRoleRequest
|
|
366
|
-
queryRole(this: That, params?: T.SecurityQueryRoleRequest
|
|
363
|
+
queryRole(this: That, params?: T.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryRoleResponse>;
|
|
364
|
+
queryRole(this: That, params?: T.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryRoleResponse, unknown>>;
|
|
365
|
+
queryRole(this: That, params?: T.SecurityQueryRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryRoleResponse>;
|
|
367
366
|
/**
|
|
368
367
|
* Find users with a query. Get information for users in a paginated manner. You can optionally filter the results with a query.
|
|
369
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
368
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-query-user.html | Elasticsearch API documentation}
|
|
370
369
|
*/
|
|
371
|
-
queryUser(this: That, params?: T.SecurityQueryUserRequest
|
|
372
|
-
queryUser(this: That, params?: T.SecurityQueryUserRequest
|
|
373
|
-
queryUser(this: That, params?: T.SecurityQueryUserRequest
|
|
370
|
+
queryUser(this: That, params?: T.SecurityQueryUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryUserResponse>;
|
|
371
|
+
queryUser(this: That, params?: T.SecurityQueryUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryUserResponse, unknown>>;
|
|
372
|
+
queryUser(this: That, params?: T.SecurityQueryUserRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryUserResponse>;
|
|
374
373
|
/**
|
|
375
374
|
* Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption.
|
|
376
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
375
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-authenticate.html | Elasticsearch API documentation}
|
|
377
376
|
*/
|
|
378
|
-
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest
|
|
379
|
-
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest
|
|
380
|
-
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest
|
|
377
|
+
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
378
|
+
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlAuthenticateResponse, unknown>>;
|
|
379
|
+
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
381
380
|
/**
|
|
382
381
|
* Logout of SAML completely. Verifies the logout response sent from the SAML IdP.
|
|
383
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
382
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-complete-logout.html | Elasticsearch API documentation}
|
|
384
383
|
*/
|
|
385
|
-
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest
|
|
386
|
-
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest
|
|
387
|
-
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest
|
|
384
|
+
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
385
|
+
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlCompleteLogoutResponse, unknown>>;
|
|
386
|
+
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
388
387
|
/**
|
|
389
388
|
* Invalidate SAML. Submits a SAML LogoutRequest message to Elasticsearch for consumption.
|
|
390
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
389
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-invalidate.html | Elasticsearch API documentation}
|
|
391
390
|
*/
|
|
392
|
-
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest
|
|
393
|
-
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest
|
|
394
|
-
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest
|
|
391
|
+
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>;
|
|
392
|
+
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlInvalidateResponse, unknown>>;
|
|
393
|
+
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlInvalidateResponse>;
|
|
395
394
|
/**
|
|
396
395
|
* Logout of SAML. Submits a request to invalidate an access token and refresh token.
|
|
397
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
396
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-logout.html | Elasticsearch API documentation}
|
|
398
397
|
*/
|
|
399
|
-
samlLogout(this: That, params: T.SecuritySamlLogoutRequest
|
|
400
|
-
samlLogout(this: That, params: T.SecuritySamlLogoutRequest
|
|
401
|
-
samlLogout(this: That, params: T.SecuritySamlLogoutRequest
|
|
398
|
+
samlLogout(this: That, params: T.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>;
|
|
399
|
+
samlLogout(this: That, params: T.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlLogoutResponse, unknown>>;
|
|
400
|
+
samlLogout(this: That, params: T.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlLogoutResponse>;
|
|
402
401
|
/**
|
|
403
402
|
* Prepare SAML authentication. Creates a SAML authentication request (`<AuthnRequest>`) as a URL string, based on the configuration of the respective SAML realm in Elasticsearch.
|
|
404
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
403
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
|
|
405
404
|
*/
|
|
406
|
-
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest
|
|
407
|
-
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest
|
|
408
|
-
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest
|
|
405
|
+
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
406
|
+
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlPrepareAuthenticationResponse, unknown>>;
|
|
407
|
+
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
409
408
|
/**
|
|
410
409
|
* Create SAML service provider metadata. Generate SAML metadata for a SAML 2.0 Service Provider.
|
|
411
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
410
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
|
|
412
411
|
*/
|
|
413
|
-
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest
|
|
414
|
-
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest
|
|
415
|
-
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest
|
|
412
|
+
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
413
|
+
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlServiceProviderMetadataResponse, unknown>>;
|
|
414
|
+
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
416
415
|
/**
|
|
417
416
|
* Suggest a user profile. Get suggestions for user profiles that match specified search criteria.
|
|
418
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
417
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-suggest-user-profile.html | Elasticsearch API documentation}
|
|
419
418
|
*/
|
|
420
|
-
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest
|
|
421
|
-
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest
|
|
422
|
-
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest
|
|
419
|
+
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
420
|
+
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>;
|
|
421
|
+
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
423
422
|
/**
|
|
424
423
|
* Update an API key. Updates attributes of an existing API key. Users can only update API keys that they created or that were granted to them. Use this API to update API keys created by the create API Key or grant API Key APIs. If you need to apply the same update to many API keys, you can use bulk update API Keys to reduce overhead. It’s not possible to update expired API keys, or API keys that have been invalidated by invalidate API Key. This API supports updates to an API key’s access scope and metadata. The access scope of an API key is derived from the `role_descriptors` you specify in the request, and a snapshot of the owner user’s permissions at the time of the request. The snapshot of the owner’s permissions is updated automatically on every call. If you don’t specify `role_descriptors` in the request, a call to this API might still change the API key’s access scope. This change can occur if the owner user’s permissions have changed since the API key was created or last modified. To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. IMPORTANT: It’s not possible to use an API key as the authentication credential for this API. To update an API key, the owner user’s credentials are required.
|
|
425
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
424
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-api-key.html | Elasticsearch API documentation}
|
|
426
425
|
*/
|
|
427
|
-
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest
|
|
428
|
-
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest
|
|
429
|
-
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest
|
|
426
|
+
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
427
|
+
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateApiKeyResponse, unknown>>;
|
|
428
|
+
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
430
429
|
/**
|
|
431
430
|
* Update a cross-cluster API key. Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.
|
|
432
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
431
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
433
432
|
*/
|
|
434
|
-
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest
|
|
435
|
-
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest
|
|
436
|
-
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest
|
|
433
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateCrossClusterApiKeyResponse>;
|
|
434
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateCrossClusterApiKeyResponse, unknown>>;
|
|
435
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateCrossClusterApiKeyResponse>;
|
|
437
436
|
/**
|
|
438
437
|
* Update settings for the security system index
|
|
439
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
438
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-settings.html | Elasticsearch API documentation}
|
|
440
439
|
*/
|
|
441
|
-
updateSettings(this: That, params?: T.TODO
|
|
442
|
-
updateSettings(this: That, params?: T.TODO
|
|
443
|
-
updateSettings(this: That, params?: T.TODO
|
|
440
|
+
updateSettings(this: That, params?: T.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
441
|
+
updateSettings(this: That, params?: T.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
442
|
+
updateSettings(this: That, params?: T.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
444
443
|
/**
|
|
445
444
|
* Update user profile data. Update specific data for the user profile that is associated with a unique ID.
|
|
446
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/
|
|
445
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-user-profile-data.html | Elasticsearch API documentation}
|
|
447
446
|
*/
|
|
448
|
-
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest
|
|
449
|
-
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest
|
|
450
|
-
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest
|
|
447
|
+
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>;
|
|
448
|
+
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>;
|
|
449
|
+
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateUserProfileDataResponse>;
|
|
451
450
|
}
|
|
452
451
|
export {};
|