@elastic/elasticsearch 8.8.1 → 8.9.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.
Files changed (185) hide show
  1. package/README.md +42 -81
  2. package/catalog-info.yaml +4 -4
  3. package/lib/api/api/async_search.d.ts +16 -0
  4. package/lib/api/api/async_search.js.map +1 -1
  5. package/lib/api/api/autoscaling.d.ts +16 -0
  6. package/lib/api/api/autoscaling.js.map +1 -1
  7. package/lib/api/api/bulk.d.ts +4 -0
  8. package/lib/api/api/bulk.js.map +1 -1
  9. package/lib/api/api/cat.d.ts +104 -0
  10. package/lib/api/api/cat.js.map +1 -1
  11. package/lib/api/api/ccr.d.ts +52 -0
  12. package/lib/api/api/ccr.js.map +1 -1
  13. package/lib/api/api/clear_scroll.d.ts +4 -0
  14. package/lib/api/api/clear_scroll.js.map +1 -1
  15. package/lib/api/api/close_point_in_time.d.ts +4 -0
  16. package/lib/api/api/close_point_in_time.js.map +1 -1
  17. package/lib/api/api/cluster.d.ts +67 -0
  18. package/lib/api/api/cluster.js +17 -0
  19. package/lib/api/api/cluster.js.map +1 -1
  20. package/lib/api/api/count.d.ts +4 -0
  21. package/lib/api/api/count.js.map +1 -1
  22. package/lib/api/api/create.d.ts +4 -0
  23. package/lib/api/api/create.js.map +1 -1
  24. package/lib/api/api/dangling_indices.d.ts +12 -0
  25. package/lib/api/api/dangling_indices.js.map +1 -1
  26. package/lib/api/api/delete.d.ts +4 -0
  27. package/lib/api/api/delete.js.map +1 -1
  28. package/lib/api/api/delete_by_query.d.ts +4 -0
  29. package/lib/api/api/delete_by_query.js.map +1 -1
  30. package/lib/api/api/delete_by_query_rethrottle.d.ts +4 -0
  31. package/lib/api/api/delete_by_query_rethrottle.js.map +1 -1
  32. package/lib/api/api/delete_script.d.ts +4 -0
  33. package/lib/api/api/delete_script.js.map +1 -1
  34. package/lib/api/api/enrich.d.ts +20 -0
  35. package/lib/api/api/enrich.js.map +1 -1
  36. package/lib/api/api/eql.d.ts +16 -0
  37. package/lib/api/api/eql.js.map +1 -1
  38. package/lib/api/api/exists.d.ts +4 -0
  39. package/lib/api/api/exists.js.map +1 -1
  40. package/lib/api/api/exists_source.d.ts +4 -0
  41. package/lib/api/api/exists_source.js.map +1 -1
  42. package/lib/api/api/explain.d.ts +4 -0
  43. package/lib/api/api/explain.js.map +1 -1
  44. package/lib/api/api/features.d.ts +8 -0
  45. package/lib/api/api/features.js.map +1 -1
  46. package/lib/api/api/field_caps.d.ts +4 -0
  47. package/lib/api/api/field_caps.js.map +1 -1
  48. package/lib/api/api/fleet.d.ts +10 -0
  49. package/lib/api/api/fleet.js.map +1 -1
  50. package/lib/api/api/get.d.ts +4 -0
  51. package/lib/api/api/get.js.map +1 -1
  52. package/lib/api/api/get_script.d.ts +4 -0
  53. package/lib/api/api/get_script.js.map +1 -1
  54. package/lib/api/api/get_script_context.d.ts +4 -0
  55. package/lib/api/api/get_script_context.js.map +1 -1
  56. package/lib/api/api/get_script_languages.d.ts +4 -0
  57. package/lib/api/api/get_script_languages.js.map +1 -1
  58. package/lib/api/api/get_source.d.ts +4 -0
  59. package/lib/api/api/get_source.js.map +1 -1
  60. package/lib/api/api/graph.d.ts +4 -0
  61. package/lib/api/api/graph.js.map +1 -1
  62. package/lib/api/api/health_report.d.ts +4 -0
  63. package/lib/api/api/health_report.js.map +1 -1
  64. package/lib/api/api/ilm.d.ts +44 -0
  65. package/lib/api/api/ilm.js.map +1 -1
  66. package/lib/api/api/index.d.ts +4 -0
  67. package/lib/api/api/index.js.map +1 -1
  68. package/lib/api/api/indices.d.ts +232 -0
  69. package/lib/api/api/indices.js.map +1 -1
  70. package/lib/api/api/info.d.ts +4 -0
  71. package/lib/api/api/info.js.map +1 -1
  72. package/lib/api/api/ingest.d.ts +24 -0
  73. package/lib/api/api/ingest.js.map +1 -1
  74. package/lib/api/api/knn_search.d.ts +4 -0
  75. package/lib/api/api/knn_search.js.map +1 -1
  76. package/lib/api/api/license.d.ts +28 -0
  77. package/lib/api/api/license.js.map +1 -1
  78. package/lib/api/api/logstash.d.ts +12 -0
  79. package/lib/api/api/logstash.js.map +1 -1
  80. package/lib/api/api/mget.d.ts +4 -0
  81. package/lib/api/api/mget.js.map +1 -1
  82. package/lib/api/api/migration.d.ts +12 -0
  83. package/lib/api/api/migration.js.map +1 -1
  84. package/lib/api/api/ml.d.ts +292 -0
  85. package/lib/api/api/ml.js.map +1 -1
  86. package/lib/api/api/monitoring.d.ts +4 -0
  87. package/lib/api/api/monitoring.js.map +1 -1
  88. package/lib/api/api/msearch.d.ts +4 -0
  89. package/lib/api/api/msearch.js.map +1 -1
  90. package/lib/api/api/msearch_template.d.ts +4 -0
  91. package/lib/api/api/msearch_template.js.map +1 -1
  92. package/lib/api/api/mtermvectors.d.ts +4 -0
  93. package/lib/api/api/mtermvectors.js.map +1 -1
  94. package/lib/api/api/nodes.d.ts +28 -0
  95. package/lib/api/api/nodes.js.map +1 -1
  96. package/lib/api/api/open_point_in_time.d.ts +4 -0
  97. package/lib/api/api/open_point_in_time.js.map +1 -1
  98. package/lib/api/api/ping.d.ts +4 -0
  99. package/lib/api/api/ping.js.map +1 -1
  100. package/lib/api/api/put_script.d.ts +4 -0
  101. package/lib/api/api/put_script.js.map +1 -1
  102. package/lib/api/api/rank_eval.d.ts +4 -0
  103. package/lib/api/api/rank_eval.js.map +1 -1
  104. package/lib/api/api/reindex.d.ts +4 -0
  105. package/lib/api/api/reindex.js.map +1 -1
  106. package/lib/api/api/reindex_rethrottle.d.ts +4 -0
  107. package/lib/api/api/reindex_rethrottle.js.map +1 -1
  108. package/lib/api/api/render_search_template.d.ts +4 -0
  109. package/lib/api/api/render_search_template.js.map +1 -1
  110. package/lib/api/api/rollup.d.ts +32 -0
  111. package/lib/api/api/rollup.js.map +1 -1
  112. package/lib/api/api/scripts_painless_execute.d.ts +4 -0
  113. package/lib/api/api/scripts_painless_execute.js.map +1 -1
  114. package/lib/api/api/scroll.d.ts +4 -0
  115. package/lib/api/api/scroll.js.map +1 -1
  116. package/lib/api/api/search.d.ts +4 -0
  117. package/lib/api/api/search.js.map +1 -1
  118. package/lib/api/api/search_application.d.ts +43 -0
  119. package/lib/api/api/search_application.js +17 -0
  120. package/lib/api/api/search_application.js.map +1 -1
  121. package/lib/api/api/search_mvt.d.ts +4 -0
  122. package/lib/api/api/search_mvt.js.map +1 -1
  123. package/lib/api/api/search_shards.d.ts +4 -0
  124. package/lib/api/api/search_shards.js.map +1 -1
  125. package/lib/api/api/search_template.d.ts +4 -0
  126. package/lib/api/api/search_template.js.map +1 -1
  127. package/lib/api/api/searchable_snapshots.d.ts +16 -0
  128. package/lib/api/api/searchable_snapshots.js.map +1 -1
  129. package/lib/api/api/security.d.ts +234 -0
  130. package/lib/api/api/security.js +34 -0
  131. package/lib/api/api/security.js.map +1 -1
  132. package/lib/api/api/shutdown.d.ts +12 -0
  133. package/lib/api/api/shutdown.js.map +1 -1
  134. package/lib/api/api/slm.d.ts +36 -0
  135. package/lib/api/api/slm.js.map +1 -1
  136. package/lib/api/api/snapshot.d.ts +48 -0
  137. package/lib/api/api/snapshot.js.map +1 -1
  138. package/lib/api/api/sql.d.ts +24 -0
  139. package/lib/api/api/sql.js.map +1 -1
  140. package/lib/api/api/ssl.d.ts +4 -0
  141. package/lib/api/api/ssl.js.map +1 -1
  142. package/lib/api/api/synonyms.d.ts +32 -0
  143. package/lib/api/api/synonyms.js +84 -0
  144. package/lib/api/api/synonyms.js.map +1 -0
  145. package/lib/api/api/tasks.d.ts +12 -0
  146. package/lib/api/api/tasks.js.map +1 -1
  147. package/lib/api/api/terms_enum.d.ts +4 -0
  148. package/lib/api/api/terms_enum.js.map +1 -1
  149. package/lib/api/api/termvectors.d.ts +4 -0
  150. package/lib/api/api/termvectors.js.map +1 -1
  151. package/lib/api/api/text_structure.d.ts +4 -0
  152. package/lib/api/api/text_structure.js.map +1 -1
  153. package/lib/api/api/transform.d.ts +44 -0
  154. package/lib/api/api/transform.js.map +1 -1
  155. package/lib/api/api/update.d.ts +4 -0
  156. package/lib/api/api/update.js.map +1 -1
  157. package/lib/api/api/update_by_query.d.ts +4 -0
  158. package/lib/api/api/update_by_query.js.map +1 -1
  159. package/lib/api/api/update_by_query_rethrottle.d.ts +4 -0
  160. package/lib/api/api/update_by_query_rethrottle.js.map +1 -1
  161. package/lib/api/api/watcher.d.ts +52 -0
  162. package/lib/api/api/watcher.js.map +1 -1
  163. package/lib/api/api/xpack.d.ts +8 -0
  164. package/lib/api/api/xpack.js.map +1 -1
  165. package/lib/api/index.d.ts +4 -0
  166. package/lib/api/index.js +14 -2
  167. package/lib/api/index.js.map +1 -1
  168. package/lib/api/types.d.ts +26 -12
  169. package/lib/api/typesWithBodyKey.d.ts +26 -12
  170. package/lib/client.js +1 -1
  171. package/lib/client.js.map +1 -1
  172. package/lib/helpers.d.ts +5 -3
  173. package/lib/helpers.js +8 -9
  174. package/lib/helpers.js.map +1 -1
  175. package/package.json +4 -4
  176. package/.buildkite/Dockerfile +0 -14
  177. package/.buildkite/functions/cleanup.sh +0 -67
  178. package/.buildkite/functions/imports.sh +0 -60
  179. package/.buildkite/functions/wait-for-container.sh +0 -36
  180. package/.buildkite/pipeline.yml +0 -30
  181. package/.buildkite/run-client.sh +0 -31
  182. package/.buildkite/run-elasticsearch.sh +0 -152
  183. package/.buildkite/run-tests.sh +0 -16
  184. package/free-report-junit.xml +0 -6
  185. package/platinum-report-junit.xml +0 -14
@@ -7,168 +7,402 @@ interface That {
7
7
  export default class Security {
8
8
  transport: Transport;
9
9
  constructor(transport: Transport);
10
+ /**
11
+ * Creates or updates the user profile on behalf of another user.
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-activate-user-profile.html | Elasticsearch API documentation}
13
+ */
10
14
  activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>;
11
15
  activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>;
12
16
  activateUserProfile(this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>;
17
+ /**
18
+ * Enables authentication as a user and retrieve information about the authenticated user.
19
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-authenticate.html | Elasticsearch API documentation}
20
+ */
13
21
  authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityAuthenticateResponse>;
14
22
  authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityAuthenticateResponse, unknown>>;
15
23
  authenticate(this: That, params?: T.SecurityAuthenticateRequest | TB.SecurityAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecurityAuthenticateResponse>;
24
+ /**
25
+ * Updates the attributes of multiple existing API keys.
26
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
27
+ */
16
28
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
17
29
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
18
30
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
31
+ /**
32
+ * Changes the passwords of users in the native realm and built-in users.
33
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-change-password.html | Elasticsearch API documentation}
34
+ */
19
35
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>;
20
36
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityChangePasswordResponse, unknown>>;
21
37
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise<T.SecurityChangePasswordResponse>;
38
+ /**
39
+ * Clear a subset or all entries from the API key cache.
40
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
41
+ */
22
42
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>;
23
43
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearApiKeyCacheResponse, unknown>>;
24
44
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise<T.SecurityClearApiKeyCacheResponse>;
45
+ /**
46
+ * Evicts application privileges from the native application privileges cache.
47
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
48
+ */
25
49
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>;
26
50
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedPrivilegesResponse, unknown>>;
27
51
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedPrivilegesResponse>;
52
+ /**
53
+ * Evicts users from the user cache. Can completely clear the cache or evict specific users.
54
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-cache.html | Elasticsearch API documentation}
55
+ */
28
56
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>;
29
57
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRealmsResponse, unknown>>;
30
58
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRealmsResponse>;
59
+ /**
60
+ * Evicts roles from the native role cache.
61
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-role-cache.html | Elasticsearch API documentation}
62
+ */
31
63
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>;
32
64
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRolesResponse, unknown>>;
33
65
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRolesResponse>;
66
+ /**
67
+ * Evicts tokens from the service account token caches.
68
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
69
+ */
34
70
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>;
35
71
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedServiceTokensResponse, unknown>>;
36
72
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedServiceTokensResponse>;
73
+ /**
74
+ * Creates an API key for access without requiring basic authentication.
75
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-api-key.html | Elasticsearch API documentation}
76
+ */
37
77
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>;
38
78
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateApiKeyResponse, unknown>>;
39
79
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateApiKeyResponse>;
80
+ /**
81
+ * Creates a cross-cluster API key for API key based remote cluster access.
82
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
83
+ */
84
+ createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
85
+ createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
86
+ createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
87
+ /**
88
+ * Creates a service account token for access without requiring basic authentication.
89
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-create-service-token.html | Elasticsearch API documentation}
90
+ */
40
91
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>;
41
92
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateServiceTokenResponse, unknown>>;
42
93
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateServiceTokenResponse>;
94
+ /**
95
+ * Removes application privileges.
96
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-privilege.html | Elasticsearch API documentation}
97
+ */
43
98
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>;
44
99
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeletePrivilegesResponse, unknown>>;
45
100
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityDeletePrivilegesResponse>;
101
+ /**
102
+ * Removes roles in the native realm.
103
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-role.html | Elasticsearch API documentation}
104
+ */
46
105
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>;
47
106
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleResponse, unknown>>;
48
107
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleResponse>;
108
+ /**
109
+ * Removes role mappings.
110
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-role-mapping.html | Elasticsearch API documentation}
111
+ */
49
112
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>;
50
113
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleMappingResponse, unknown>>;
51
114
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleMappingResponse>;
115
+ /**
116
+ * Deletes a service account token.
117
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-service-token.html | Elasticsearch API documentation}
118
+ */
52
119
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>;
53
120
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteServiceTokenResponse, unknown>>;
54
121
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteServiceTokenResponse>;
122
+ /**
123
+ * Deletes users from the native realm.
124
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-delete-user.html | Elasticsearch API documentation}
125
+ */
55
126
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>;
56
127
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteUserResponse, unknown>>;
57
128
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteUserResponse>;
129
+ /**
130
+ * Disables users in the native realm.
131
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-disable-user.html | Elasticsearch API documentation}
132
+ */
58
133
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>;
59
134
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserResponse, unknown>>;
60
135
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserResponse>;
136
+ /**
137
+ * Disables a user profile so it's not visible in user profile searches.
138
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-disable-user-profile.html | Elasticsearch API documentation}
139
+ */
61
140
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>;
62
141
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>;
63
142
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>;
143
+ /**
144
+ * Enables users in the native realm.
145
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-enable-user.html | Elasticsearch API documentation}
146
+ */
64
147
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>;
65
148
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserResponse, unknown>>;
66
149
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserResponse>;
150
+ /**
151
+ * Enables a user profile so it's visible in user profile searches.
152
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-enable-user-profile.html | Elasticsearch API documentation}
153
+ */
67
154
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>;
68
155
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>;
69
156
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>;
157
+ /**
158
+ * Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster.
159
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-kibana-enrollment.html | Elasticsearch API documentation}
160
+ */
70
161
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>;
71
162
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollKibanaResponse, unknown>>;
72
163
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollKibanaResponse>;
164
+ /**
165
+ * Allows a new node to enroll to an existing cluster with security enabled.
166
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-node-enrollment.html | Elasticsearch API documentation}
167
+ */
73
168
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>;
74
169
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollNodeResponse, unknown>>;
75
170
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollNodeResponse>;
171
+ /**
172
+ * Retrieves information for one or more API keys.
173
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-api-key.html | Elasticsearch API documentation}
174
+ */
76
175
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>;
77
176
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetApiKeyResponse, unknown>>;
78
177
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGetApiKeyResponse>;
178
+ /**
179
+ * Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch.
180
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
181
+ */
79
182
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
80
183
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetBuiltinPrivilegesResponse, unknown>>;
81
184
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
185
+ /**
186
+ * Retrieves application privileges.
187
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-privileges.html | Elasticsearch API documentation}
188
+ */
82
189
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>;
83
190
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetPrivilegesResponse, unknown>>;
84
191
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetPrivilegesResponse>;
192
+ /**
193
+ * Retrieves roles in the native realm.
194
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-role.html | Elasticsearch API documentation}
195
+ */
85
196
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>;
86
197
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleResponse, unknown>>;
87
198
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleResponse>;
199
+ /**
200
+ * Retrieves role mappings.
201
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-role-mapping.html | Elasticsearch API documentation}
202
+ */
88
203
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>;
89
204
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleMappingResponse, unknown>>;
90
205
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleMappingResponse>;
206
+ /**
207
+ * Retrieves information about service accounts.
208
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-service-accounts.html | Elasticsearch API documentation}
209
+ */
91
210
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>;
92
211
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceAccountsResponse, unknown>>;
93
212
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceAccountsResponse>;
213
+ /**
214
+ * Retrieves information of all service credentials for a service account.
215
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-service-credentials.html | Elasticsearch API documentation}
216
+ */
94
217
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>;
95
218
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceCredentialsResponse, unknown>>;
96
219
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceCredentialsResponse>;
220
+ /**
221
+ * Creates a bearer token for access without requiring basic authentication.
222
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-token.html | Elasticsearch API documentation}
223
+ */
97
224
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>;
98
225
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetTokenResponse, unknown>>;
99
226
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityGetTokenResponse>;
227
+ /**
228
+ * Retrieves information about users in the native realm and built-in users.
229
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user.html | Elasticsearch API documentation}
230
+ */
100
231
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>;
101
232
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserResponse, unknown>>;
102
233
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserResponse>;
234
+ /**
235
+ * Retrieves security privileges for the logged in user.
236
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user-privileges.html | Elasticsearch API documentation}
237
+ */
103
238
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>;
104
239
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserPrivilegesResponse, unknown>>;
105
240
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserPrivilegesResponse>;
241
+ /**
242
+ * Retrieves user profiles for the given unique ID(s).
243
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-get-user-profile.html | Elasticsearch API documentation}
244
+ */
106
245
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>;
107
246
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>;
108
247
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>;
248
+ /**
249
+ * Creates an API key on behalf of another user.
250
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-grant-api-key.html | Elasticsearch API documentation}
251
+ */
109
252
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>;
110
253
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGrantApiKeyResponse, unknown>>;
111
254
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGrantApiKeyResponse>;
255
+ /**
256
+ * Determines whether the specified user has a specified list of privileges.
257
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-has-privileges.html | Elasticsearch API documentation}
258
+ */
112
259
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>;
113
260
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesResponse, unknown>>;
114
261
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesResponse>;
262
+ /**
263
+ * Determines whether the users associated with the specified profile IDs have all the requested privileges.
264
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
265
+ */
115
266
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
116
267
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesUserProfileResponse, unknown>>;
117
268
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
269
+ /**
270
+ * Invalidates one or more API keys.
271
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-invalidate-api-key.html | Elasticsearch API documentation}
272
+ */
118
273
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>;
119
274
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateApiKeyResponse, unknown>>;
120
275
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateApiKeyResponse>;
276
+ /**
277
+ * Invalidates one or more access tokens or refresh tokens.
278
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-invalidate-token.html | Elasticsearch API documentation}
279
+ */
121
280
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>;
122
281
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateTokenResponse, unknown>>;
123
282
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateTokenResponse>;
283
+ /**
284
+ * Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
285
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-authenticate.html | Elasticsearch API documentation}
286
+ */
124
287
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
125
288
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
126
289
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
290
+ /**
291
+ * Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
292
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-logout.html | Elasticsearch API documentation}
293
+ */
127
294
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
128
295
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
129
296
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
297
+ /**
298
+ * Creates an OAuth 2.0 authentication request as a URL string
299
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
300
+ */
130
301
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
131
302
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
132
303
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
304
+ /**
305
+ * Adds or updates application privileges.
306
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-privileges.html | Elasticsearch API documentation}
307
+ */
133
308
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>;
134
309
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutPrivilegesResponse, unknown>>;
135
310
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityPutPrivilegesResponse>;
311
+ /**
312
+ * Adds and updates roles in the native realm.
313
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-role.html | Elasticsearch API documentation}
314
+ */
136
315
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>;
137
316
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleResponse, unknown>>;
138
317
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleResponse>;
318
+ /**
319
+ * Creates and updates role mappings.
320
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-role-mapping.html | Elasticsearch API documentation}
321
+ */
139
322
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>;
140
323
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleMappingResponse, unknown>>;
141
324
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>;
325
+ /**
326
+ * Adds and updates users in the native realm. These users are commonly referred to as native users.
327
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-put-user.html | Elasticsearch API documentation}
328
+ */
142
329
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>;
143
330
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutUserResponse, unknown>>;
144
331
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptions): Promise<T.SecurityPutUserResponse>;
332
+ /**
333
+ * Retrieves information for API keys using a subset of query DSL
334
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-query-api-key.html | Elasticsearch API documentation}
335
+ */
145
336
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>;
146
337
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryApiKeysResponse, unknown>>;
147
338
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryApiKeysResponse>;
339
+ /**
340
+ * Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
341
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-authenticate.html | Elasticsearch API documentation}
342
+ */
148
343
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>;
149
344
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlAuthenticateResponse, unknown>>;
150
345
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlAuthenticateResponse>;
346
+ /**
347
+ * Verifies the logout response sent from the SAML IdP
348
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-complete-logout.html | Elasticsearch API documentation}
349
+ */
151
350
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>;
152
351
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlCompleteLogoutResponse, unknown>>;
153
352
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlCompleteLogoutResponse>;
353
+ /**
354
+ * Consumes a SAML LogoutRequest
355
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-invalidate.html | Elasticsearch API documentation}
356
+ */
154
357
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>;
155
358
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlInvalidateResponse, unknown>>;
156
359
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlInvalidateResponse>;
360
+ /**
361
+ * Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
362
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-logout.html | Elasticsearch API documentation}
363
+ */
157
364
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>;
158
365
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlLogoutResponse, unknown>>;
159
366
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlLogoutResponse>;
367
+ /**
368
+ * Creates a SAML authentication request
369
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
370
+ */
160
371
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
161
372
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlPrepareAuthenticationResponse, unknown>>;
162
373
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
374
+ /**
375
+ * Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
376
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
377
+ */
163
378
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
164
379
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlServiceProviderMetadataResponse, unknown>>;
165
380
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
381
+ /**
382
+ * Get suggestions for user profiles that match specified search criteria.
383
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-suggest-user-profile.html | Elasticsearch API documentation}
384
+ */
166
385
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>;
167
386
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>;
168
387
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>;
388
+ /**
389
+ * Updates attributes of an existing API key.
390
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-api-key.html | Elasticsearch API documentation}
391
+ */
169
392
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>;
170
393
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateApiKeyResponse, unknown>>;
171
394
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>;
395
+ /**
396
+ * Updates attributes of an existing cross-cluster API key.
397
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
398
+ */
399
+ updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
400
+ updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
401
+ updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
402
+ /**
403
+ * Update application specific data for the user profile of the given unique ID.
404
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.9/security-api-update-user-profile-data.html | Elasticsearch API documentation}
405
+ */
172
406
  updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>;
173
407
  updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>;
174
408
  updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateUserProfileDataResponse>;
@@ -251,6 +251,23 @@ class Security {
251
251
  const path = '/_security/api_key';
252
252
  return await this.transport.request({ path, method, querystring, body }, options);
253
253
  }
254
+ async createCrossClusterApiKey(params, options) {
255
+ const acceptedPath = [];
256
+ const querystring = {};
257
+ const body = undefined;
258
+ params = params !== null && params !== void 0 ? params : {};
259
+ for (const key in params) {
260
+ if (acceptedPath.includes(key)) {
261
+ continue;
262
+ }
263
+ else if (key !== 'body') {
264
+ querystring[key] = params[key];
265
+ }
266
+ }
267
+ const method = 'POST';
268
+ const path = '/_security/cross_cluster/api_key';
269
+ return await this.transport.request({ path, method, querystring, body }, options);
270
+ }
254
271
  async createServiceToken(params, options) {
255
272
  const acceptedPath = ['namespace', 'service', 'name'];
256
273
  const querystring = {};
@@ -1325,6 +1342,23 @@ class Security {
1325
1342
  const path = `/_security/api_key/${encodeURIComponent(params.id.toString())}`;
1326
1343
  return await this.transport.request({ path, method, querystring, body }, options);
1327
1344
  }
1345
+ async updateCrossClusterApiKey(params, options) {
1346
+ const acceptedPath = ['id'];
1347
+ const querystring = {};
1348
+ const body = undefined;
1349
+ params = params !== null && params !== void 0 ? params : {};
1350
+ for (const key in params) {
1351
+ if (acceptedPath.includes(key)) {
1352
+ continue;
1353
+ }
1354
+ else if (key !== 'body') {
1355
+ querystring[key] = params[key];
1356
+ }
1357
+ }
1358
+ const method = 'PUT';
1359
+ const path = `/_security/cross_cluster/api_key/${encodeURIComponent(params.id.toString())}`;
1360
+ return await this.transport.request({ path, method, querystring, body }, options);
1361
+ }
1328
1362
  async updateUserProfileData(params, options) {
1329
1363
  const acceptedPath = ['uid'];
1330
1364
  const acceptedBody = ['labels', 'data'];