@elastic/elasticsearch 8.15.2 → 8.16.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.
- package/.tap/processinfo/{2050cc30-f488-420a-baa6-df6c1adb9f62.json → 239708f2-87a5-4d74-b278-39bed70e3132.json} +27 -27
- package/.tap/processinfo/{92769d56-f3fd-425e-a62b-a405b7b3cee8.json → 49cc5ee3-23ef-4e56-a9eb-a60b09ab2869.json} +18 -18
- package/.tap/processinfo/{737e7e75-4bfb-4692-ab93-26301ccaae30.json → 50399bf2-cbc5-48a1-9c21-6844fe8df15b.json} +39 -39
- package/.tap/processinfo/{7cb18475-5a98-4019-9680-455975cefd95.json → 6efa79f2-1d5f-4eec-a53e-1cbdfca97357.json} +31 -31
- package/.tap/processinfo/{d68b7470-ec92-4a05-a899-ef7b846ea57f.json → ba5d04e5-a2fc-4645-a145-b1091b008ba2.json} +55 -55
- package/.tap/processinfo/{0a539d4d-d7bd-4b6d-86dc-d42a6e9c6c57.json → e350be2a-80f7-4405-be6d-9387eb5c62a5.json} +28 -28
- package/.tap/processinfo/{9b27c491-d2fb-4fd1-a726-2145fef1295a.json → faf6b959-b0f5-4608-9f59-62f75993b578.json} +35 -35
- package/lib/api/api/async_search.d.ts +8 -8
- package/lib/api/api/async_search.js.map +1 -1
- package/lib/api/api/autoscaling.d.ts +8 -8
- package/lib/api/api/autoscaling.js.map +1 -1
- package/lib/api/api/bulk.d.ts +2 -2
- package/lib/api/api/bulk.js.map +1 -1
- package/lib/api/api/capabilities.d.ts +1 -1
- package/lib/api/api/capabilities.js.map +1 -1
- package/lib/api/api/cat.d.ts +36 -36
- package/lib/api/api/cat.js.map +1 -1
- package/lib/api/api/ccr.d.ts +13 -13
- package/lib/api/api/ccr.js.map +1 -1
- package/lib/api/api/clear_scroll.d.ts +2 -2
- package/lib/api/api/clear_scroll.js.map +1 -1
- package/lib/api/api/close_point_in_time.d.ts +2 -2
- package/lib/api/api/close_point_in_time.js.map +1 -1
- package/lib/api/api/cluster.d.ts +21 -21
- package/lib/api/api/cluster.js.map +1 -1
- package/lib/api/api/connector.d.ts +55 -55
- package/lib/api/api/connector.js.map +1 -1
- package/lib/api/api/count.d.ts +1 -1
- package/lib/api/api/count.js.map +1 -1
- package/lib/api/api/create.d.ts +2 -2
- package/lib/api/api/create.js.map +1 -1
- package/lib/api/api/dangling_indices.d.ts +6 -6
- package/lib/api/api/dangling_indices.js.map +1 -1
- package/lib/api/api/delete.d.ts +2 -2
- package/lib/api/api/delete.js.map +1 -1
- package/lib/api/api/delete_by_query.d.ts +2 -2
- package/lib/api/api/delete_by_query.js.map +1 -1
- package/lib/api/api/delete_by_query_rethrottle.d.ts +2 -2
- package/lib/api/api/delete_by_query_rethrottle.js.map +1 -1
- package/lib/api/api/delete_script.d.ts +2 -2
- package/lib/api/api/delete_script.js.map +1 -1
- package/lib/api/api/enrich.d.ts +9 -9
- package/lib/api/api/enrich.js.map +1 -1
- package/lib/api/api/eql.d.ts +4 -4
- package/lib/api/api/eql.js.map +1 -1
- package/lib/api/api/esql.d.ts +3 -3
- package/lib/api/api/esql.js +1 -1
- package/lib/api/api/esql.js.map +1 -1
- package/lib/api/api/exists.d.ts +2 -2
- package/lib/api/api/exists.js.map +1 -1
- package/lib/api/api/exists_source.d.ts +2 -2
- package/lib/api/api/exists_source.js.map +1 -1
- package/lib/api/api/explain.d.ts +2 -2
- package/lib/api/api/explain.js.map +1 -1
- package/lib/api/api/features.d.ts +2 -2
- package/lib/api/api/features.js.map +1 -1
- package/lib/api/api/field_caps.d.ts +2 -2
- package/lib/api/api/field_caps.js.map +1 -1
- package/lib/api/api/fleet.d.ts +1 -1
- package/lib/api/api/fleet.js.map +1 -1
- package/lib/api/api/get.d.ts +2 -2
- package/lib/api/api/get.js.map +1 -1
- package/lib/api/api/get_script.d.ts +2 -2
- package/lib/api/api/get_script.js.map +1 -1
- package/lib/api/api/get_script_context.d.ts +2 -2
- package/lib/api/api/get_script_context.js.map +1 -1
- package/lib/api/api/get_script_languages.d.ts +2 -2
- package/lib/api/api/get_script_languages.js.map +1 -1
- package/lib/api/api/get_source.d.ts +2 -2
- package/lib/api/api/get_source.js.map +1 -1
- package/lib/api/api/graph.d.ts +1 -1
- package/lib/api/api/graph.js.map +1 -1
- package/lib/api/api/health_report.d.ts +1 -1
- package/lib/api/api/health_report.js.map +1 -1
- package/lib/api/api/ilm.d.ts +11 -11
- package/lib/api/api/ilm.js.map +1 -1
- package/lib/api/api/index.d.ts +2 -2
- package/lib/api/api/index.js.map +1 -1
- package/lib/api/api/indices.d.ts +88 -88
- package/lib/api/api/indices.js.map +1 -1
- package/lib/api/api/inference.d.ts +11 -4
- package/lib/api/api/inference.js +32 -0
- package/lib/api/api/inference.js.map +1 -1
- package/lib/api/api/info.d.ts +2 -2
- package/lib/api/api/info.js.map +1 -1
- package/lib/api/api/ingest.d.ts +12 -12
- package/lib/api/api/ingest.js +1 -2
- package/lib/api/api/ingest.js.map +1 -1
- package/lib/api/api/knn_search.d.ts +2 -2
- package/lib/api/api/knn_search.js.map +1 -1
- package/lib/api/api/license.d.ts +8 -8
- package/lib/api/api/license.js.map +1 -1
- package/lib/api/api/logstash.d.ts +3 -3
- package/lib/api/api/logstash.js.map +1 -1
- package/lib/api/api/mget.d.ts +2 -2
- package/lib/api/api/mget.js.map +1 -1
- package/lib/api/api/migration.d.ts +3 -3
- package/lib/api/api/migration.js.map +1 -1
- package/lib/api/api/ml.d.ts +144 -144
- package/lib/api/api/ml.js.map +1 -1
- package/lib/api/api/monitoring.d.ts +1 -1
- package/lib/api/api/monitoring.js.map +1 -1
- package/lib/api/api/msearch.d.ts +2 -2
- package/lib/api/api/msearch.js.map +1 -1
- package/lib/api/api/msearch_template.d.ts +2 -2
- package/lib/api/api/msearch_template.js.map +1 -1
- package/lib/api/api/mtermvectors.d.ts +2 -2
- package/lib/api/api/mtermvectors.js.map +1 -1
- package/lib/api/api/nodes.d.ts +7 -7
- package/lib/api/api/nodes.js.map +1 -1
- package/lib/api/api/open_point_in_time.d.ts +2 -2
- package/lib/api/api/open_point_in_time.js +16 -2
- package/lib/api/api/open_point_in_time.js.map +1 -1
- package/lib/api/api/ping.d.ts +2 -2
- package/lib/api/api/ping.js.map +1 -1
- package/lib/api/api/profiling.d.ts +4 -4
- package/lib/api/api/profiling.js.map +1 -1
- package/lib/api/api/put_script.d.ts +2 -2
- package/lib/api/api/put_script.js.map +1 -1
- package/lib/api/api/query_rules.d.ts +14 -7
- package/lib/api/api/query_rules.js +37 -0
- package/lib/api/api/query_rules.js.map +1 -1
- package/lib/api/api/rank_eval.d.ts +2 -2
- package/lib/api/api/rank_eval.js.map +1 -1
- package/lib/api/api/reindex.d.ts +2 -2
- package/lib/api/api/reindex.js.map +1 -1
- package/lib/api/api/reindex_rethrottle.d.ts +2 -2
- package/lib/api/api/reindex_rethrottle.js.map +1 -1
- package/lib/api/api/render_search_template.d.ts +2 -2
- package/lib/api/api/render_search_template.js.map +1 -1
- package/lib/api/api/rollup.d.ts +8 -8
- package/lib/api/api/rollup.js.map +1 -1
- package/lib/api/api/scripts_painless_execute.d.ts +2 -2
- package/lib/api/api/scripts_painless_execute.js.map +1 -1
- package/lib/api/api/scroll.d.ts +2 -2
- package/lib/api/api/scroll.js.map +1 -1
- package/lib/api/api/search.d.ts +2 -2
- package/lib/api/api/search.js.map +1 -1
- package/lib/api/api/search_application.d.ts +16 -16
- package/lib/api/api/search_application.js.map +1 -1
- package/lib/api/api/search_mvt.d.ts +2 -2
- package/lib/api/api/search_mvt.js.map +1 -1
- package/lib/api/api/search_shards.d.ts +2 -2
- package/lib/api/api/search_shards.js.map +1 -1
- package/lib/api/api/search_template.d.ts +2 -2
- package/lib/api/api/search_template.js.map +1 -1
- package/lib/api/api/searchable_snapshots.d.ts +4 -4
- package/lib/api/api/searchable_snapshots.js.map +1 -1
- package/lib/api/api/security.d.ts +126 -126
- package/lib/api/api/security.js +35 -7
- package/lib/api/api/security.js.map +1 -1
- package/lib/api/api/shutdown.js.map +1 -1
- package/lib/api/api/simulate.d.ts +1 -1
- package/lib/api/api/simulate.js.map +1 -1
- package/lib/api/api/slm.d.ts +9 -9
- package/lib/api/api/slm.js.map +1 -1
- package/lib/api/api/snapshot.d.ts +19 -12
- package/lib/api/api/snapshot.js +23 -0
- package/lib/api/api/snapshot.js.map +1 -1
- package/lib/api/api/sql.d.ts +6 -6
- package/lib/api/api/sql.js.map +1 -1
- package/lib/api/api/ssl.d.ts +2 -2
- package/lib/api/api/ssl.js.map +1 -1
- package/lib/api/api/synonyms.d.ts +7 -7
- package/lib/api/api/synonyms.js.map +1 -1
- package/lib/api/api/tasks.d.ts +4 -4
- package/lib/api/api/tasks.js.map +1 -1
- package/lib/api/api/terms_enum.d.ts +2 -2
- package/lib/api/api/terms_enum.js.map +1 -1
- package/lib/api/api/termvectors.d.ts +2 -2
- package/lib/api/api/termvectors.js.map +1 -1
- package/lib/api/api/text_structure.d.ts +4 -4
- package/lib/api/api/text_structure.js.map +1 -1
- package/lib/api/api/transform.d.ts +22 -22
- package/lib/api/api/transform.js.map +1 -1
- package/lib/api/api/update.d.ts +2 -2
- package/lib/api/api/update.js.map +1 -1
- package/lib/api/api/update_by_query.d.ts +2 -2
- package/lib/api/api/update_by_query.js.map +1 -1
- package/lib/api/api/update_by_query_rethrottle.d.ts +2 -2
- package/lib/api/api/update_by_query_rethrottle.js.map +1 -1
- package/lib/api/api/watcher.d.ts +13 -13
- package/lib/api/api/watcher.js.map +1 -1
- package/lib/api/api/xpack.d.ts +2 -2
- package/lib/api/api/xpack.js.map +1 -1
- package/lib/api/index.js.map +1 -1
- package/lib/api/types.d.ts +517 -79
- package/lib/api/types.js.map +1 -1
- package/lib/api/typesWithBodyKey.d.ts +529 -79
- package/lib/api/typesWithBodyKey.js.map +1 -1
- package/lib/client.d.ts +2 -2
- package/lib/client.js +33 -17
- package/lib/client.js.map +1 -1
- package/lib/helpers.d.ts +8 -2
- package/lib/helpers.js +41 -12
- package/lib/helpers.js.map +1 -1
- package/lib/sniffingTransport.js +2 -2
- package/lib/sniffingTransport.js.map +1 -1
- package/package.json +17 -13
- package/tsconfig.json +3 -2
|
@@ -8,442 +8,442 @@ export default class Security {
|
|
|
8
8
|
transport: Transport;
|
|
9
9
|
constructor(transport: Transport);
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
12
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
11
|
+
* 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/8.16/security-api-activate-user-profile.html | Elasticsearch API documentation}
|
|
13
13
|
*/
|
|
14
14
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>;
|
|
15
15
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>;
|
|
16
16
|
activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>;
|
|
17
17
|
/**
|
|
18
|
-
*
|
|
19
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
18
|
+
* 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/8.16/security-api-authenticate.html | Elasticsearch API documentation}
|
|
20
20
|
*/
|
|
21
21
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityAuthenticateResponse>;
|
|
22
22
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityAuthenticateResponse, unknown>>;
|
|
23
23
|
authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecurityAuthenticateResponse>;
|
|
24
24
|
/**
|
|
25
|
-
* 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/8.
|
|
25
|
+
* 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/8.16/security-api-bulk-delete-role.html | Elasticsearch API documentation}
|
|
27
27
|
*/
|
|
28
28
|
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkDeleteRoleResponse>;
|
|
29
29
|
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkDeleteRoleResponse, unknown>>;
|
|
30
30
|
bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkDeleteRoleResponse>;
|
|
31
31
|
/**
|
|
32
|
-
* 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/8.
|
|
32
|
+
* 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/8.16/security-api-bulk-put-role.html | Elasticsearch API documentation}
|
|
34
34
|
*/
|
|
35
35
|
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkPutRoleResponse>;
|
|
36
36
|
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkPutRoleResponse, unknown>>;
|
|
37
37
|
bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkPutRoleResponse>;
|
|
38
38
|
/**
|
|
39
39
|
* Updates the attributes of multiple existing API keys.
|
|
40
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
40
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
|
|
41
41
|
*/
|
|
42
42
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
43
43
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
44
44
|
bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
45
45
|
/**
|
|
46
|
-
*
|
|
47
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
46
|
+
* 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/8.16/security-api-change-password.html | Elasticsearch API documentation}
|
|
48
48
|
*/
|
|
49
49
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>;
|
|
50
50
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityChangePasswordResponse, unknown>>;
|
|
51
51
|
changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise<T.SecurityChangePasswordResponse>;
|
|
52
52
|
/**
|
|
53
|
-
*
|
|
54
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
53
|
+
* 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/8.16/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
|
|
55
55
|
*/
|
|
56
56
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
57
57
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearApiKeyCacheResponse, unknown>>;
|
|
58
58
|
clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise<T.SecurityClearApiKeyCacheResponse>;
|
|
59
59
|
/**
|
|
60
|
-
*
|
|
61
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
60
|
+
* 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/8.16/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
|
|
62
62
|
*/
|
|
63
63
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
64
64
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedPrivilegesResponse, unknown>>;
|
|
65
65
|
clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedPrivilegesResponse>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
68
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
67
|
+
* 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/8.16/security-api-clear-cache.html | Elasticsearch API documentation}
|
|
69
69
|
*/
|
|
70
70
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
71
71
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRealmsResponse, unknown>>;
|
|
72
72
|
clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRealmsResponse>;
|
|
73
73
|
/**
|
|
74
|
-
*
|
|
75
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
74
|
+
* Clear the roles cache. Evict roles from the native role cache.
|
|
75
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-clear-role-cache.html | Elasticsearch API documentation}
|
|
76
76
|
*/
|
|
77
77
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>;
|
|
78
78
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRolesResponse, unknown>>;
|
|
79
79
|
clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRolesResponse>;
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
82
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
81
|
+
* 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/8.16/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
|
|
83
83
|
*/
|
|
84
84
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
85
85
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedServiceTokensResponse, unknown>>;
|
|
86
86
|
clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedServiceTokensResponse>;
|
|
87
87
|
/**
|
|
88
|
-
*
|
|
89
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
88
|
+
* 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/8.16/security-api-create-api-key.html | Elasticsearch API documentation}
|
|
90
90
|
*/
|
|
91
91
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>;
|
|
92
92
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateApiKeyResponse, unknown>>;
|
|
93
93
|
createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateApiKeyResponse>;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
96
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
95
|
+
* 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/8.16/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
97
97
|
*/
|
|
98
|
-
createCrossClusterApiKey(this: That, params
|
|
99
|
-
createCrossClusterApiKey(this: That, params
|
|
100
|
-
createCrossClusterApiKey(this: That, params
|
|
98
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest | TB.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateCrossClusterApiKeyResponse>;
|
|
99
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest | TB.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateCrossClusterApiKeyResponse, unknown>>;
|
|
100
|
+
createCrossClusterApiKey(this: That, params: T.SecurityCreateCrossClusterApiKeyRequest | TB.SecurityCreateCrossClusterApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateCrossClusterApiKeyResponse>;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
103
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
102
|
+
* 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/8.16/security-api-create-service-token.html | Elasticsearch API documentation}
|
|
104
104
|
*/
|
|
105
105
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
106
106
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateServiceTokenResponse, unknown>>;
|
|
107
107
|
createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateServiceTokenResponse>;
|
|
108
108
|
/**
|
|
109
|
-
*
|
|
110
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
109
|
+
* Delete application privileges.
|
|
110
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-delete-privilege.html | Elasticsearch API documentation}
|
|
111
111
|
*/
|
|
112
112
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
113
113
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeletePrivilegesResponse, unknown>>;
|
|
114
114
|
deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityDeletePrivilegesResponse>;
|
|
115
115
|
/**
|
|
116
|
-
*
|
|
117
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
116
|
+
* Delete roles. Delete roles in the native realm.
|
|
117
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-delete-role.html | Elasticsearch API documentation}
|
|
118
118
|
*/
|
|
119
119
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>;
|
|
120
120
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleResponse, unknown>>;
|
|
121
121
|
deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleResponse>;
|
|
122
122
|
/**
|
|
123
|
-
*
|
|
124
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
123
|
+
* Delete role mappings.
|
|
124
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-delete-role-mapping.html | Elasticsearch API documentation}
|
|
125
125
|
*/
|
|
126
126
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
127
127
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleMappingResponse, unknown>>;
|
|
128
128
|
deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleMappingResponse>;
|
|
129
129
|
/**
|
|
130
|
-
*
|
|
131
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
130
|
+
* 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/8.16/security-api-delete-service-token.html | Elasticsearch API documentation}
|
|
132
132
|
*/
|
|
133
133
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
134
134
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteServiceTokenResponse, unknown>>;
|
|
135
135
|
deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteServiceTokenResponse>;
|
|
136
136
|
/**
|
|
137
|
-
*
|
|
138
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
137
|
+
* Delete users. Delete users from the native realm.
|
|
138
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-delete-user.html | Elasticsearch API documentation}
|
|
139
139
|
*/
|
|
140
140
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>;
|
|
141
141
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteUserResponse, unknown>>;
|
|
142
142
|
deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteUserResponse>;
|
|
143
143
|
/**
|
|
144
|
-
*
|
|
145
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
144
|
+
* Disable users. Disable users in the native realm.
|
|
145
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-disable-user.html | Elasticsearch API documentation}
|
|
146
146
|
*/
|
|
147
147
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>;
|
|
148
148
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserResponse, unknown>>;
|
|
149
149
|
disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserResponse>;
|
|
150
150
|
/**
|
|
151
|
-
*
|
|
152
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
151
|
+
* 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/8.16/security-api-disable-user-profile.html | Elasticsearch API documentation}
|
|
153
153
|
*/
|
|
154
154
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>;
|
|
155
155
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>;
|
|
156
156
|
disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>;
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
159
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
158
|
+
* Enable users. Enable users in the native realm.
|
|
159
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-enable-user.html | Elasticsearch API documentation}
|
|
160
160
|
*/
|
|
161
161
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>;
|
|
162
162
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserResponse, unknown>>;
|
|
163
163
|
enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserResponse>;
|
|
164
164
|
/**
|
|
165
|
-
*
|
|
166
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
165
|
+
* 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/8.16/security-api-enable-user-profile.html | Elasticsearch API documentation}
|
|
167
167
|
*/
|
|
168
168
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>;
|
|
169
169
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>;
|
|
170
170
|
enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>;
|
|
171
171
|
/**
|
|
172
|
-
*
|
|
173
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
172
|
+
* 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/8.16/security-api-kibana-enrollment.html | Elasticsearch API documentation}
|
|
174
174
|
*/
|
|
175
175
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>;
|
|
176
176
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollKibanaResponse, unknown>>;
|
|
177
177
|
enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollKibanaResponse>;
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
180
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
179
|
+
* 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/8.16/security-api-node-enrollment.html | Elasticsearch API documentation}
|
|
181
181
|
*/
|
|
182
182
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>;
|
|
183
183
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollNodeResponse, unknown>>;
|
|
184
184
|
enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollNodeResponse>;
|
|
185
185
|
/**
|
|
186
|
-
* 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/8.
|
|
186
|
+
* 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/8.16/security-api-get-api-key.html | Elasticsearch API documentation}
|
|
188
188
|
*/
|
|
189
189
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>;
|
|
190
190
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetApiKeyResponse, unknown>>;
|
|
191
191
|
getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGetApiKeyResponse>;
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
193
|
+
* 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/8.16/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
|
|
195
195
|
*/
|
|
196
196
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
197
197
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetBuiltinPrivilegesResponse, unknown>>;
|
|
198
198
|
getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
|
|
199
199
|
/**
|
|
200
|
-
*
|
|
201
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
200
|
+
* Get application privileges.
|
|
201
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-privileges.html | Elasticsearch API documentation}
|
|
202
202
|
*/
|
|
203
203
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>;
|
|
204
204
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetPrivilegesResponse, unknown>>;
|
|
205
205
|
getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetPrivilegesResponse>;
|
|
206
206
|
/**
|
|
207
|
-
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.
|
|
208
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
207
|
+
* Get roles. Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.
|
|
208
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-role.html | Elasticsearch API documentation}
|
|
209
209
|
*/
|
|
210
210
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>;
|
|
211
211
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleResponse, unknown>>;
|
|
212
212
|
getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleResponse>;
|
|
213
213
|
/**
|
|
214
|
-
*
|
|
215
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
214
|
+
* 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/8.16/security-api-get-role-mapping.html | Elasticsearch API documentation}
|
|
216
216
|
*/
|
|
217
217
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>;
|
|
218
218
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleMappingResponse, unknown>>;
|
|
219
219
|
getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleMappingResponse>;
|
|
220
220
|
/**
|
|
221
|
-
*
|
|
222
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
221
|
+
* 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/8.16/security-api-get-service-accounts.html | Elasticsearch API documentation}
|
|
223
223
|
*/
|
|
224
224
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
225
225
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceAccountsResponse, unknown>>;
|
|
226
226
|
getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceAccountsResponse>;
|
|
227
227
|
/**
|
|
228
|
-
*
|
|
229
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
228
|
+
* Get service account credentials.
|
|
229
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-service-credentials.html | Elasticsearch API documentation}
|
|
230
230
|
*/
|
|
231
231
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
232
232
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceCredentialsResponse, unknown>>;
|
|
233
233
|
getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceCredentialsResponse>;
|
|
234
234
|
/**
|
|
235
235
|
* Retrieve settings for the security system indices
|
|
236
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
236
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-settings.html | Elasticsearch API documentation}
|
|
237
237
|
*/
|
|
238
238
|
getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
239
239
|
getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
240
240
|
getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
241
241
|
/**
|
|
242
|
-
*
|
|
243
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
242
|
+
* Get a token. Create a bearer token for access without requiring basic authentication.
|
|
243
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-token.html | Elasticsearch API documentation}
|
|
244
244
|
*/
|
|
245
245
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>;
|
|
246
246
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetTokenResponse, unknown>>;
|
|
247
247
|
getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityGetTokenResponse>;
|
|
248
248
|
/**
|
|
249
|
-
*
|
|
250
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
249
|
+
* 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/8.16/security-api-get-user.html | Elasticsearch API documentation}
|
|
251
251
|
*/
|
|
252
252
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>;
|
|
253
253
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserResponse, unknown>>;
|
|
254
254
|
getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserResponse>;
|
|
255
255
|
/**
|
|
256
|
-
*
|
|
257
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
256
|
+
* Get user privileges.
|
|
257
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-get-user-privileges.html | Elasticsearch API documentation}
|
|
258
258
|
*/
|
|
259
259
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
260
260
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserPrivilegesResponse, unknown>>;
|
|
261
261
|
getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserPrivilegesResponse>;
|
|
262
262
|
/**
|
|
263
|
-
*
|
|
264
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
263
|
+
* 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/8.16/security-api-get-user-profile.html | Elasticsearch API documentation}
|
|
265
265
|
*/
|
|
266
266
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>;
|
|
267
267
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>;
|
|
268
268
|
getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>;
|
|
269
269
|
/**
|
|
270
|
-
*
|
|
271
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
270
|
+
* 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/8.16/security-api-grant-api-key.html | Elasticsearch API documentation}
|
|
272
272
|
*/
|
|
273
273
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>;
|
|
274
274
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGrantApiKeyResponse, unknown>>;
|
|
275
275
|
grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGrantApiKeyResponse>;
|
|
276
276
|
/**
|
|
277
|
-
*
|
|
278
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
277
|
+
* 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/8.16/security-api-has-privileges.html | Elasticsearch API documentation}
|
|
279
279
|
*/
|
|
280
280
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>;
|
|
281
281
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesResponse, unknown>>;
|
|
282
282
|
hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesResponse>;
|
|
283
283
|
/**
|
|
284
|
-
*
|
|
285
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
284
|
+
* 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/8.16/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
|
|
286
286
|
*/
|
|
287
287
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
288
288
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesUserProfileResponse, unknown>>;
|
|
289
289
|
hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
|
|
290
290
|
/**
|
|
291
|
-
*
|
|
292
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
291
|
+
* 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/8.16/security-api-invalidate-api-key.html | Elasticsearch API documentation}
|
|
293
293
|
*/
|
|
294
294
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
295
295
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateApiKeyResponse, unknown>>;
|
|
296
296
|
invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateApiKeyResponse>;
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
299
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
298
|
+
* 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/8.16/security-api-invalidate-token.html | Elasticsearch API documentation}
|
|
300
300
|
*/
|
|
301
301
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>;
|
|
302
302
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateTokenResponse, unknown>>;
|
|
303
303
|
invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateTokenResponse>;
|
|
304
304
|
/**
|
|
305
305
|
* 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/8.
|
|
306
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-oidc-authenticate.html | Elasticsearch API documentation}
|
|
307
307
|
*/
|
|
308
308
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
309
309
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
310
310
|
oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
311
311
|
/**
|
|
312
312
|
* 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/8.
|
|
313
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-oidc-logout.html | Elasticsearch API documentation}
|
|
314
314
|
*/
|
|
315
315
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
316
316
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
317
317
|
oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
318
318
|
/**
|
|
319
319
|
* Creates an OAuth 2.0 authentication request as a URL string
|
|
320
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
320
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
|
|
321
321
|
*/
|
|
322
322
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
323
323
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
324
324
|
oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
325
325
|
/**
|
|
326
|
-
*
|
|
327
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
326
|
+
* Create or update application privileges.
|
|
327
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-put-privileges.html | Elasticsearch API documentation}
|
|
328
328
|
*/
|
|
329
329
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>;
|
|
330
330
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutPrivilegesResponse, unknown>>;
|
|
331
331
|
putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityPutPrivilegesResponse>;
|
|
332
332
|
/**
|
|
333
|
-
* The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The create or update roles API cannot update roles that are defined in roles files.
|
|
334
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
333
|
+
* 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/8.16/security-api-put-role.html | Elasticsearch API documentation}
|
|
335
335
|
*/
|
|
336
336
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>;
|
|
337
337
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleResponse, unknown>>;
|
|
338
338
|
putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleResponse>;
|
|
339
339
|
/**
|
|
340
|
-
*
|
|
341
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
340
|
+
* 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/8.16/security-api-put-role-mapping.html | Elasticsearch API documentation}
|
|
342
342
|
*/
|
|
343
343
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>;
|
|
344
344
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleMappingResponse, unknown>>;
|
|
345
345
|
putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>;
|
|
346
346
|
/**
|
|
347
|
-
*
|
|
348
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
347
|
+
* 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/8.16/security-api-put-user.html | Elasticsearch API documentation}
|
|
349
349
|
*/
|
|
350
350
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>;
|
|
351
351
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutUserResponse, unknown>>;
|
|
352
352
|
putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptions): Promise<T.SecurityPutUserResponse>;
|
|
353
353
|
/**
|
|
354
|
-
*
|
|
355
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
354
|
+
* 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/8.16/security-api-query-api-key.html | Elasticsearch API documentation}
|
|
356
356
|
*/
|
|
357
357
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>;
|
|
358
358
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryApiKeysResponse, unknown>>;
|
|
359
359
|
queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryApiKeysResponse>;
|
|
360
360
|
/**
|
|
361
|
-
*
|
|
362
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
361
|
+
* 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/8.16/security-api-query-role.html | Elasticsearch API documentation}
|
|
363
363
|
*/
|
|
364
364
|
queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryRoleResponse>;
|
|
365
365
|
queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryRoleResponse, unknown>>;
|
|
366
366
|
queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryRoleResponse>;
|
|
367
367
|
/**
|
|
368
|
-
*
|
|
369
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
368
|
+
* 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/8.16/security-api-query-user.html | Elasticsearch API documentation}
|
|
370
370
|
*/
|
|
371
371
|
queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryUserResponse>;
|
|
372
372
|
queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryUserResponse, unknown>>;
|
|
373
373
|
queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryUserResponse>;
|
|
374
374
|
/**
|
|
375
|
-
* Submits a SAML
|
|
376
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
375
|
+
* Authenticate SAML. Submits a SAML response message to Elasticsearch for consumption.
|
|
376
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-saml-authenticate.html | Elasticsearch API documentation}
|
|
377
377
|
*/
|
|
378
378
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
379
379
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlAuthenticateResponse, unknown>>;
|
|
380
380
|
samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlAuthenticateResponse>;
|
|
381
381
|
/**
|
|
382
|
-
* Verifies the logout response sent from the SAML IdP.
|
|
383
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
382
|
+
* Logout of SAML completely. Verifies the logout response sent from the SAML IdP.
|
|
383
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-saml-complete-logout.html | Elasticsearch API documentation}
|
|
384
384
|
*/
|
|
385
385
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
386
386
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlCompleteLogoutResponse, unknown>>;
|
|
387
387
|
samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlCompleteLogoutResponse>;
|
|
388
388
|
/**
|
|
389
|
-
* Submits a SAML LogoutRequest message to Elasticsearch for consumption.
|
|
390
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
389
|
+
* Invalidate SAML. Submits a SAML LogoutRequest message to Elasticsearch for consumption.
|
|
390
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-saml-invalidate.html | Elasticsearch API documentation}
|
|
391
391
|
*/
|
|
392
392
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>;
|
|
393
393
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlInvalidateResponse, unknown>>;
|
|
394
394
|
samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlInvalidateResponse>;
|
|
395
395
|
/**
|
|
396
|
-
* Submits a request to invalidate an access token and refresh token.
|
|
397
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
396
|
+
* 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/8.16/security-api-saml-logout.html | Elasticsearch API documentation}
|
|
398
398
|
*/
|
|
399
399
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>;
|
|
400
400
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlLogoutResponse, unknown>>;
|
|
401
401
|
samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlLogoutResponse>;
|
|
402
402
|
/**
|
|
403
|
-
* Creates a SAML authentication request (
|
|
404
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
403
|
+
* 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/8.16/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
|
|
405
405
|
*/
|
|
406
406
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
407
407
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlPrepareAuthenticationResponse, unknown>>;
|
|
408
408
|
samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
|
|
409
409
|
/**
|
|
410
|
-
* Generate SAML metadata for a SAML 2.0 Service Provider.
|
|
411
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
410
|
+
* 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/8.16/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
|
|
412
412
|
*/
|
|
413
413
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
414
414
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlServiceProviderMetadataResponse, unknown>>;
|
|
415
415
|
samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
|
|
416
416
|
/**
|
|
417
|
-
* Get suggestions for user profiles that match specified search criteria.
|
|
418
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
417
|
+
* 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/8.16/security-api-suggest-user-profile.html | Elasticsearch API documentation}
|
|
419
419
|
*/
|
|
420
420
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
421
421
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>;
|
|
422
422
|
suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>;
|
|
423
423
|
/**
|
|
424
|
-
* 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/8.
|
|
424
|
+
* 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/8.16/security-api-update-api-key.html | Elasticsearch API documentation}
|
|
426
426
|
*/
|
|
427
427
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
428
428
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateApiKeyResponse, unknown>>;
|
|
429
429
|
updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>;
|
|
430
430
|
/**
|
|
431
|
-
*
|
|
432
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
431
|
+
* 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/8.16/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
|
|
433
433
|
*/
|
|
434
|
-
updateCrossClusterApiKey(this: That, params
|
|
435
|
-
updateCrossClusterApiKey(this: That, params
|
|
436
|
-
updateCrossClusterApiKey(this: That, params
|
|
434
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest | TB.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateCrossClusterApiKeyResponse>;
|
|
435
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest | TB.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateCrossClusterApiKeyResponse, unknown>>;
|
|
436
|
+
updateCrossClusterApiKey(this: That, params: T.SecurityUpdateCrossClusterApiKeyRequest | TB.SecurityUpdateCrossClusterApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateCrossClusterApiKeyResponse>;
|
|
437
437
|
/**
|
|
438
438
|
* Update settings for the security system index
|
|
439
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
439
|
+
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.16/security-api-update-settings.html | Elasticsearch API documentation}
|
|
440
440
|
*/
|
|
441
441
|
updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
|
|
442
442
|
updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
|
|
443
443
|
updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
|
|
444
444
|
/**
|
|
445
|
-
*
|
|
446
|
-
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
445
|
+
* 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/8.16/security-api-update-user-profile-data.html | Elasticsearch API documentation}
|
|
447
447
|
*/
|
|
448
448
|
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>;
|
|
449
449
|
updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>;
|