@elastic/elasticsearch 8.14.1 → 8.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (109) hide show
  1. package/catalog-info.yaml +9 -9
  2. package/lib/api/api/async_search.d.ts +8 -8
  3. package/lib/api/api/autoscaling.d.ts +4 -4
  4. package/lib/api/api/bulk.d.ts +2 -2
  5. package/lib/api/api/capabilities.d.ts +14 -0
  6. package/lib/api/api/capabilities.js +42 -0
  7. package/lib/api/api/capabilities.js.map +1 -0
  8. package/lib/api/api/cat.d.ts +51 -51
  9. package/lib/api/api/ccr.d.ts +13 -13
  10. package/lib/api/api/clear_scroll.d.ts +2 -2
  11. package/lib/api/api/close_point_in_time.d.ts +2 -2
  12. package/lib/api/api/cluster.d.ts +24 -24
  13. package/lib/api/api/connector.d.ts +67 -53
  14. package/lib/api/api/connector.js +59 -3
  15. package/lib/api/api/connector.js.map +1 -1
  16. package/lib/api/api/count.d.ts +1 -1
  17. package/lib/api/api/create.d.ts +2 -2
  18. package/lib/api/api/dangling_indices.d.ts +3 -3
  19. package/lib/api/api/delete.d.ts +2 -2
  20. package/lib/api/api/delete_by_query.d.ts +2 -2
  21. package/lib/api/api/delete_by_query_rethrottle.d.ts +1 -1
  22. package/lib/api/api/delete_script.d.ts +2 -2
  23. package/lib/api/api/enrich.d.ts +8 -8
  24. package/lib/api/api/eql.d.ts +7 -7
  25. package/lib/api/api/esql.d.ts +4 -4
  26. package/lib/api/api/exists.d.ts +2 -2
  27. package/lib/api/api/exists_source.d.ts +2 -2
  28. package/lib/api/api/explain.d.ts +2 -2
  29. package/lib/api/api/features.d.ts +2 -2
  30. package/lib/api/api/field_caps.d.ts +2 -2
  31. package/lib/api/api/fleet.d.ts +3 -3
  32. package/lib/api/api/get.d.ts +1 -1
  33. package/lib/api/api/get_script.d.ts +2 -2
  34. package/lib/api/api/get_script_context.d.ts +1 -1
  35. package/lib/api/api/get_script_languages.d.ts +1 -1
  36. package/lib/api/api/get_source.d.ts +1 -1
  37. package/lib/api/api/graph.d.ts +2 -2
  38. package/lib/api/api/health_report.d.ts +1 -1
  39. package/lib/api/api/ilm.d.ts +16 -16
  40. package/lib/api/api/index.d.ts +2 -2
  41. package/lib/api/api/indices.d.ts +111 -111
  42. package/lib/api/api/inference.d.ts +17 -17
  43. package/lib/api/api/inference.js +8 -7
  44. package/lib/api/api/inference.js.map +1 -1
  45. package/lib/api/api/info.d.ts +1 -1
  46. package/lib/api/api/ingest.d.ts +33 -12
  47. package/lib/api/api/ingest.js +92 -0
  48. package/lib/api/api/ingest.js.map +1 -1
  49. package/lib/api/api/knn_search.d.ts +1 -1
  50. package/lib/api/api/license.d.ts +10 -10
  51. package/lib/api/api/logstash.d.ts +6 -6
  52. package/lib/api/api/mget.d.ts +1 -1
  53. package/lib/api/api/migration.d.ts +3 -3
  54. package/lib/api/api/ml.d.ts +131 -131
  55. package/lib/api/api/monitoring.d.ts +1 -1
  56. package/lib/api/api/msearch.d.ts +1 -1
  57. package/lib/api/api/msearch_template.d.ts +2 -2
  58. package/lib/api/api/mtermvectors.d.ts +1 -1
  59. package/lib/api/api/nodes.d.ts +14 -14
  60. package/lib/api/api/open_point_in_time.d.ts +2 -2
  61. package/lib/api/api/ping.d.ts +1 -1
  62. package/lib/api/api/profiling.d.ts +4 -4
  63. package/lib/api/api/put_script.d.ts +2 -2
  64. package/lib/api/api/query_rules.d.ts +60 -0
  65. package/lib/api/api/{query_ruleset.js → query_rules.js} +97 -11
  66. package/lib/api/api/query_rules.js.map +1 -0
  67. package/lib/api/api/rank_eval.d.ts +2 -2
  68. package/lib/api/api/reindex.d.ts +1 -1
  69. package/lib/api/api/reindex_rethrottle.d.ts +2 -2
  70. package/lib/api/api/render_search_template.d.ts +2 -2
  71. package/lib/api/api/rollup.d.ts +10 -10
  72. package/lib/api/api/scripts_painless_execute.d.ts +2 -2
  73. package/lib/api/api/scroll.d.ts +1 -1
  74. package/lib/api/api/search.d.ts +2 -2
  75. package/lib/api/api/search_application.d.ts +11 -11
  76. package/lib/api/api/search_mvt.d.ts +1 -1
  77. package/lib/api/api/search_shards.d.ts +1 -1
  78. package/lib/api/api/search_template.d.ts +2 -2
  79. package/lib/api/api/searchable_snapshots.d.ts +4 -4
  80. package/lib/api/api/security.d.ts +108 -87
  81. package/lib/api/api/security.js +121 -3
  82. package/lib/api/api/security.js.map +1 -1
  83. package/lib/api/api/simulate.d.ts +1 -1
  84. package/lib/api/api/slm.d.ts +9 -9
  85. package/lib/api/api/snapshot.d.ts +13 -13
  86. package/lib/api/api/sql.d.ts +6 -6
  87. package/lib/api/api/ssl.d.ts +1 -1
  88. package/lib/api/api/synonyms.d.ts +8 -8
  89. package/lib/api/api/tasks.d.ts +4 -4
  90. package/lib/api/api/terms_enum.d.ts +1 -1
  91. package/lib/api/api/termvectors.d.ts +1 -1
  92. package/lib/api/api/text_structure.d.ts +4 -4
  93. package/lib/api/api/transform.d.ts +26 -19
  94. package/lib/api/api/transform.js +20 -0
  95. package/lib/api/api/transform.js.map +1 -1
  96. package/lib/api/api/update.d.ts +1 -1
  97. package/lib/api/api/update_by_query.d.ts +2 -2
  98. package/lib/api/api/update_by_query_rethrottle.d.ts +1 -1
  99. package/lib/api/api/watcher.d.ts +14 -14
  100. package/lib/api/api/xpack.d.ts +4 -4
  101. package/lib/api/index.d.ts +6 -4
  102. package/lib/api/index.js +8 -6
  103. package/lib/api/index.js.map +1 -1
  104. package/lib/api/types.d.ts +672 -249
  105. package/lib/api/typesWithBodyKey.d.ts +691 -250
  106. package/lib/helpers.d.ts +1 -0
  107. package/package.json +5 -4
  108. package/lib/api/api/query_ruleset.d.ts +0 -39
  109. package/lib/api/api/query_ruleset.js.map +0 -1
@@ -8,421 +8,442 @@ export default class Security {
8
8
  transport: Transport;
9
9
  constructor(transport: Transport);
10
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.14/security-api-activate-user-profile.html | Elasticsearch API documentation}
11
+ * Creates or updates a user profile on behalf of another user.
12
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/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
- * Enables authentication as a user and retrieve information about the authenticated user.
19
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-authenticate.html | Elasticsearch API documentation}
18
+ * Enables you to submit a request with a basic auth header to authenticate a user and retrieve information about the authenticated user. 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.15/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
+ /**
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.15/security-api-bulk-delete-role.html | Elasticsearch API documentation}
27
+ */
28
+ bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkDeleteRoleResponse>;
29
+ bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkDeleteRoleResponse, unknown>>;
30
+ bulkDeleteRole(this: That, params: T.SecurityBulkDeleteRoleRequest | TB.SecurityBulkDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkDeleteRoleResponse>;
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.15/security-api-bulk-put-role.html | Elasticsearch API documentation}
34
+ */
35
+ bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityBulkPutRoleResponse>;
36
+ bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityBulkPutRoleResponse, unknown>>;
37
+ bulkPutRole(this: That, params: T.SecurityBulkPutRoleRequest | TB.SecurityBulkPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityBulkPutRoleResponse>;
24
38
  /**
25
39
  * Updates the attributes of multiple existing API keys.
26
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
40
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-bulk-update-api-keys.html | Elasticsearch API documentation}
27
41
  */
28
42
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
29
43
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
30
44
  bulkUpdateApiKeys(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
31
45
  /**
32
46
  * 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.14/security-api-change-password.html | Elasticsearch API documentation}
47
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-change-password.html | Elasticsearch API documentation}
34
48
  */
35
49
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityChangePasswordResponse>;
36
50
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityChangePasswordResponse, unknown>>;
37
51
  changePassword(this: That, params?: T.SecurityChangePasswordRequest | TB.SecurityChangePasswordRequest, options?: TransportRequestOptions): Promise<T.SecurityChangePasswordResponse>;
38
52
  /**
39
- * Clear a subset or all entries from the API key cache.
40
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
53
+ * Evicts 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.15/security-api-clear-api-key-cache.html | Elasticsearch API documentation}
41
55
  */
42
56
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearApiKeyCacheResponse>;
43
57
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearApiKeyCacheResponse, unknown>>;
44
58
  clearApiKeyCache(this: That, params: T.SecurityClearApiKeyCacheRequest | TB.SecurityClearApiKeyCacheRequest, options?: TransportRequestOptions): Promise<T.SecurityClearApiKeyCacheResponse>;
45
59
  /**
46
60
  * Evicts application privileges from the native application privileges cache.
47
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
61
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-clear-privilege-cache.html | Elasticsearch API documentation}
48
62
  */
49
63
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedPrivilegesResponse>;
50
64
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedPrivilegesResponse, unknown>>;
51
65
  clearCachedPrivileges(this: That, params: T.SecurityClearCachedPrivilegesRequest | TB.SecurityClearCachedPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedPrivilegesResponse>;
52
66
  /**
53
67
  * 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.14/security-api-clear-cache.html | Elasticsearch API documentation}
68
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-clear-cache.html | Elasticsearch API documentation}
55
69
  */
56
70
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRealmsResponse>;
57
71
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRealmsResponse, unknown>>;
58
72
  clearCachedRealms(this: That, params: T.SecurityClearCachedRealmsRequest | TB.SecurityClearCachedRealmsRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRealmsResponse>;
59
73
  /**
60
74
  * Evicts roles from the native role cache.
61
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-clear-role-cache.html | Elasticsearch API documentation}
75
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-clear-role-cache.html | Elasticsearch API documentation}
62
76
  */
63
77
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedRolesResponse>;
64
78
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedRolesResponse, unknown>>;
65
79
  clearCachedRoles(this: That, params: T.SecurityClearCachedRolesRequest | TB.SecurityClearCachedRolesRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedRolesResponse>;
66
80
  /**
67
81
  * Evicts tokens from the service account token caches.
68
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
82
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-clear-service-token-caches.html | Elasticsearch API documentation}
69
83
  */
70
84
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityClearCachedServiceTokensResponse>;
71
85
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityClearCachedServiceTokensResponse, unknown>>;
72
86
  clearCachedServiceTokens(this: That, params: T.SecurityClearCachedServiceTokensRequest | TB.SecurityClearCachedServiceTokensRequest, options?: TransportRequestOptions): Promise<T.SecurityClearCachedServiceTokensResponse>;
73
87
  /**
74
- * Creates an API key for access without requiring basic authentication.
75
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-create-api-key.html | Elasticsearch API documentation}
88
+ * Creates 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.15/security-api-create-api-key.html | Elasticsearch API documentation}
76
90
  */
77
91
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateApiKeyResponse>;
78
92
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateApiKeyResponse, unknown>>;
79
93
  createApiKey(this: That, params?: T.SecurityCreateApiKeyRequest | TB.SecurityCreateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateApiKeyResponse>;
80
94
  /**
81
95
  * 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.14/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
96
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-create-cross-cluster-api-key.html | Elasticsearch API documentation}
83
97
  */
84
98
  createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
85
99
  createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
86
100
  createCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
87
101
  /**
88
- * Creates a service account token for access without requiring basic authentication.
89
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-create-service-token.html | Elasticsearch API documentation}
102
+ * Creates a service accounts token for access without requiring basic authentication.
103
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-create-service-token.html | Elasticsearch API documentation}
90
104
  */
91
105
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityCreateServiceTokenResponse>;
92
106
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityCreateServiceTokenResponse, unknown>>;
93
107
  createServiceToken(this: That, params: T.SecurityCreateServiceTokenRequest | TB.SecurityCreateServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityCreateServiceTokenResponse>;
94
108
  /**
95
109
  * Removes application privileges.
96
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-delete-privilege.html | Elasticsearch API documentation}
110
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-delete-privilege.html | Elasticsearch API documentation}
97
111
  */
98
112
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeletePrivilegesResponse>;
99
113
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeletePrivilegesResponse, unknown>>;
100
114
  deletePrivileges(this: That, params: T.SecurityDeletePrivilegesRequest | TB.SecurityDeletePrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityDeletePrivilegesResponse>;
101
115
  /**
102
116
  * Removes roles in the native realm.
103
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-delete-role.html | Elasticsearch API documentation}
117
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-delete-role.html | Elasticsearch API documentation}
104
118
  */
105
119
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleResponse>;
106
120
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleResponse, unknown>>;
107
121
  deleteRole(this: That, params: T.SecurityDeleteRoleRequest | TB.SecurityDeleteRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleResponse>;
108
122
  /**
109
123
  * Removes role mappings.
110
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-delete-role-mapping.html | Elasticsearch API documentation}
124
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-delete-role-mapping.html | Elasticsearch API documentation}
111
125
  */
112
126
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteRoleMappingResponse>;
113
127
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteRoleMappingResponse, unknown>>;
114
128
  deleteRoleMapping(this: That, params: T.SecurityDeleteRoleMappingRequest | TB.SecurityDeleteRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteRoleMappingResponse>;
115
129
  /**
116
130
  * Deletes a service account token.
117
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-delete-service-token.html | Elasticsearch API documentation}
131
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-delete-service-token.html | Elasticsearch API documentation}
118
132
  */
119
133
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteServiceTokenResponse>;
120
134
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteServiceTokenResponse, unknown>>;
121
135
  deleteServiceToken(this: That, params: T.SecurityDeleteServiceTokenRequest | TB.SecurityDeleteServiceTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteServiceTokenResponse>;
122
136
  /**
123
137
  * Deletes users from the native realm.
124
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-delete-user.html | Elasticsearch API documentation}
138
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-delete-user.html | Elasticsearch API documentation}
125
139
  */
126
140
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDeleteUserResponse>;
127
141
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDeleteUserResponse, unknown>>;
128
142
  deleteUser(this: That, params: T.SecurityDeleteUserRequest | TB.SecurityDeleteUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDeleteUserResponse>;
129
143
  /**
130
144
  * Disables users in the native realm.
131
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-disable-user.html | Elasticsearch API documentation}
145
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-disable-user.html | Elasticsearch API documentation}
132
146
  */
133
147
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserResponse>;
134
148
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserResponse, unknown>>;
135
149
  disableUser(this: That, params: T.SecurityDisableUserRequest | TB.SecurityDisableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserResponse>;
136
150
  /**
137
151
  * 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.14/security-api-disable-user-profile.html | Elasticsearch API documentation}
152
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-disable-user-profile.html | Elasticsearch API documentation}
139
153
  */
140
154
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>;
141
155
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>;
142
156
  disableUserProfile(this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>;
143
157
  /**
144
158
  * Enables users in the native realm.
145
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-enable-user.html | Elasticsearch API documentation}
159
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-enable-user.html | Elasticsearch API documentation}
146
160
  */
147
161
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserResponse>;
148
162
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserResponse, unknown>>;
149
163
  enableUser(this: That, params: T.SecurityEnableUserRequest | TB.SecurityEnableUserRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserResponse>;
150
164
  /**
151
165
  * Enables a user profile so it's visible in user profile searches.
152
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-enable-user-profile.html | Elasticsearch API documentation}
166
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-enable-user-profile.html | Elasticsearch API documentation}
153
167
  */
154
168
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>;
155
169
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>;
156
170
  enableUserProfile(this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>;
157
171
  /**
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.14/security-api-kibana-enrollment.html | Elasticsearch API documentation}
172
+ * Enables 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.15/security-api-kibana-enrollment.html | Elasticsearch API documentation}
160
174
  */
161
175
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollKibanaResponse>;
162
176
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollKibanaResponse, unknown>>;
163
177
  enrollKibana(this: That, params?: T.SecurityEnrollKibanaRequest | TB.SecurityEnrollKibanaRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollKibanaResponse>;
164
178
  /**
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.14/security-api-node-enrollment.html | Elasticsearch API documentation}
179
+ * Allows a new node to join an existing cluster with security features enabled.
180
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-node-enrollment.html | Elasticsearch API documentation}
167
181
  */
168
182
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnrollNodeResponse>;
169
183
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnrollNodeResponse, unknown>>;
170
184
  enrollNode(this: That, params?: T.SecurityEnrollNodeRequest | TB.SecurityEnrollNodeRequest, options?: TransportRequestOptions): Promise<T.SecurityEnrollNodeResponse>;
171
185
  /**
172
- * Retrieves information for one or more API keys.
173
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-api-key.html | Elasticsearch API documentation}
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.15/security-api-get-api-key.html | Elasticsearch API documentation}
174
188
  */
175
189
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetApiKeyResponse>;
176
190
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetApiKeyResponse, unknown>>;
177
191
  getApiKey(this: That, params?: T.SecurityGetApiKeyRequest | TB.SecurityGetApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGetApiKeyResponse>;
178
192
  /**
179
193
  * 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.14/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
194
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-builtin-privileges.html | Elasticsearch API documentation}
181
195
  */
182
196
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
183
197
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetBuiltinPrivilegesResponse, unknown>>;
184
198
  getBuiltinPrivileges(this: That, params?: T.SecurityGetBuiltinPrivilegesRequest | TB.SecurityGetBuiltinPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetBuiltinPrivilegesResponse>;
185
199
  /**
186
200
  * Retrieves application privileges.
187
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-privileges.html | Elasticsearch API documentation}
201
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-privileges.html | Elasticsearch API documentation}
188
202
  */
189
203
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetPrivilegesResponse>;
190
204
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetPrivilegesResponse, unknown>>;
191
205
  getPrivileges(this: That, params?: T.SecurityGetPrivilegesRequest | TB.SecurityGetPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetPrivilegesResponse>;
192
206
  /**
193
- * Retrieves roles in the native realm.
194
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-role.html | Elasticsearch API documentation}
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.15/security-api-get-role.html | Elasticsearch API documentation}
195
209
  */
196
210
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleResponse>;
197
211
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleResponse, unknown>>;
198
212
  getRole(this: That, params?: T.SecurityGetRoleRequest | TB.SecurityGetRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleResponse>;
199
213
  /**
200
214
  * Retrieves role mappings.
201
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-role-mapping.html | Elasticsearch API documentation}
215
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-role-mapping.html | Elasticsearch API documentation}
202
216
  */
203
217
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetRoleMappingResponse>;
204
218
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetRoleMappingResponse, unknown>>;
205
219
  getRoleMapping(this: That, params?: T.SecurityGetRoleMappingRequest | TB.SecurityGetRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityGetRoleMappingResponse>;
206
220
  /**
207
- * Retrieves information about service accounts.
208
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-service-accounts.html | Elasticsearch API documentation}
221
+ * This API returns a list of service accounts that match the provided path parameter(s).
222
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-service-accounts.html | Elasticsearch API documentation}
209
223
  */
210
224
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceAccountsResponse>;
211
225
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceAccountsResponse, unknown>>;
212
226
  getServiceAccounts(this: That, params?: T.SecurityGetServiceAccountsRequest | TB.SecurityGetServiceAccountsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceAccountsResponse>;
213
227
  /**
214
228
  * Retrieves information of all service credentials for a service account.
215
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-service-credentials.html | Elasticsearch API documentation}
229
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-service-credentials.html | Elasticsearch API documentation}
216
230
  */
217
231
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetServiceCredentialsResponse>;
218
232
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetServiceCredentialsResponse, unknown>>;
219
233
  getServiceCredentials(this: That, params: T.SecurityGetServiceCredentialsRequest | TB.SecurityGetServiceCredentialsRequest, options?: TransportRequestOptions): Promise<T.SecurityGetServiceCredentialsResponse>;
220
234
  /**
221
235
  * Retrieve settings for the security system indices
222
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-settings.html | Elasticsearch API documentation}
236
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-settings.html | Elasticsearch API documentation}
223
237
  */
224
238
  getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
225
239
  getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
226
240
  getSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
227
241
  /**
228
242
  * Creates a bearer token for access without requiring basic authentication.
229
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-token.html | Elasticsearch API documentation}
243
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-token.html | Elasticsearch API documentation}
230
244
  */
231
245
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetTokenResponse>;
232
246
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetTokenResponse, unknown>>;
233
247
  getToken(this: That, params?: T.SecurityGetTokenRequest | TB.SecurityGetTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityGetTokenResponse>;
234
248
  /**
235
249
  * Retrieves information about users in the native realm and built-in users.
236
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-user.html | Elasticsearch API documentation}
250
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-user.html | Elasticsearch API documentation}
237
251
  */
238
252
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserResponse>;
239
253
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserResponse, unknown>>;
240
254
  getUser(this: That, params?: T.SecurityGetUserRequest | TB.SecurityGetUserRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserResponse>;
241
255
  /**
242
256
  * Retrieves security privileges for the logged in user.
243
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-user-privileges.html | Elasticsearch API documentation}
257
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-user-privileges.html | Elasticsearch API documentation}
244
258
  */
245
259
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserPrivilegesResponse>;
246
260
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserPrivilegesResponse, unknown>>;
247
261
  getUserPrivileges(this: That, params?: T.SecurityGetUserPrivilegesRequest | TB.SecurityGetUserPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserPrivilegesResponse>;
248
262
  /**
249
- * Retrieves user profiles for the given unique ID(s).
250
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-get-user-profile.html | Elasticsearch API documentation}
263
+ * Retrieves a user's profile using the unique profile ID.
264
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-get-user-profile.html | Elasticsearch API documentation}
251
265
  */
252
266
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>;
253
267
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>;
254
268
  getUserProfile(this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>;
255
269
  /**
256
- * Creates an API key on behalf of another user.
257
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-grant-api-key.html | Elasticsearch API documentation}
270
+ * Creates an API key on behalf of another user. This API is similar to Create API keys, 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.15/security-api-grant-api-key.html | Elasticsearch API documentation}
258
272
  */
259
273
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGrantApiKeyResponse>;
260
274
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGrantApiKeyResponse, unknown>>;
261
275
  grantApiKey(this: That, params: T.SecurityGrantApiKeyRequest | TB.SecurityGrantApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityGrantApiKeyResponse>;
262
276
  /**
263
277
  * Determines whether the specified user has a specified list of privileges.
264
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-has-privileges.html | Elasticsearch API documentation}
278
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-has-privileges.html | Elasticsearch API documentation}
265
279
  */
266
280
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesResponse>;
267
281
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesResponse, unknown>>;
268
282
  hasPrivileges(this: That, params?: T.SecurityHasPrivilegesRequest | TB.SecurityHasPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesResponse>;
269
283
  /**
270
284
  * Determines whether the users associated with the specified profile IDs have all the requested privileges.
271
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
285
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-has-privileges-user-profile.html | Elasticsearch API documentation}
272
286
  */
273
287
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
274
288
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityHasPrivilegesUserProfileResponse, unknown>>;
275
289
  hasPrivilegesUserProfile(this: That, params: T.SecurityHasPrivilegesUserProfileRequest | TB.SecurityHasPrivilegesUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityHasPrivilegesUserProfileResponse>;
276
290
  /**
277
- * Invalidates one or more API keys.
278
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-invalidate-api-key.html | Elasticsearch API documentation}
291
+ * Invalidates one or more API keys. 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, i.e. an API key invalidates itself, specify its ID in the `ids` field.
292
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-invalidate-api-key.html | Elasticsearch API documentation}
279
293
  */
280
294
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateApiKeyResponse>;
281
295
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateApiKeyResponse, unknown>>;
282
296
  invalidateApiKey(this: That, params?: T.SecurityInvalidateApiKeyRequest | TB.SecurityInvalidateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateApiKeyResponse>;
283
297
  /**
284
298
  * Invalidates one or more access tokens or refresh tokens.
285
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-invalidate-token.html | Elasticsearch API documentation}
299
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-invalidate-token.html | Elasticsearch API documentation}
286
300
  */
287
301
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityInvalidateTokenResponse>;
288
302
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityInvalidateTokenResponse, unknown>>;
289
303
  invalidateToken(this: That, params?: T.SecurityInvalidateTokenRequest | TB.SecurityInvalidateTokenRequest, options?: TransportRequestOptions): Promise<T.SecurityInvalidateTokenResponse>;
290
304
  /**
291
305
  * Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair
292
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-oidc-authenticate.html | Elasticsearch API documentation}
306
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-oidc-authenticate.html | Elasticsearch API documentation}
293
307
  */
294
308
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
295
309
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
296
310
  oidcAuthenticate(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
297
311
  /**
298
312
  * Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API
299
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-oidc-logout.html | Elasticsearch API documentation}
313
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-oidc-logout.html | Elasticsearch API documentation}
300
314
  */
301
315
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
302
316
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
303
317
  oidcLogout(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
304
318
  /**
305
319
  * Creates an OAuth 2.0 authentication request as a URL string
306
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
320
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-oidc-prepare-authentication.html | Elasticsearch API documentation}
307
321
  */
308
322
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
309
323
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
310
324
  oidcPrepareAuthentication(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
311
325
  /**
312
326
  * Adds or updates application privileges.
313
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-put-privileges.html | Elasticsearch API documentation}
327
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-put-privileges.html | Elasticsearch API documentation}
314
328
  */
315
329
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutPrivilegesResponse>;
316
330
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutPrivilegesResponse, unknown>>;
317
331
  putPrivileges(this: That, params: T.SecurityPutPrivilegesRequest | TB.SecurityPutPrivilegesRequest, options?: TransportRequestOptions): Promise<T.SecurityPutPrivilegesResponse>;
318
332
  /**
319
- * Adds and updates roles in the native realm.
320
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-put-role.html | Elasticsearch API documentation}
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.15/security-api-put-role.html | Elasticsearch API documentation}
321
335
  */
322
336
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleResponse>;
323
337
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleResponse, unknown>>;
324
338
  putRole(this: That, params: T.SecurityPutRoleRequest | TB.SecurityPutRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleResponse>;
325
339
  /**
326
340
  * Creates and updates role mappings.
327
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-put-role-mapping.html | Elasticsearch API documentation}
341
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-put-role-mapping.html | Elasticsearch API documentation}
328
342
  */
329
343
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutRoleMappingResponse>;
330
344
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutRoleMappingResponse, unknown>>;
331
345
  putRoleMapping(this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>;
332
346
  /**
333
347
  * Adds and updates users in the native realm. These users are commonly referred to as native users.
334
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-put-user.html | Elasticsearch API documentation}
348
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-put-user.html | Elasticsearch API documentation}
335
349
  */
336
350
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityPutUserResponse>;
337
351
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityPutUserResponse, unknown>>;
338
352
  putUser(this: That, params: T.SecurityPutUserRequest | TB.SecurityPutUserRequest, options?: TransportRequestOptions): Promise<T.SecurityPutUserResponse>;
339
353
  /**
340
- * Retrieves information for API keys using a subset of query DSL
341
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-query-api-key.html | Elasticsearch API documentation}
354
+ * Retrieves information for API keys in a paginated manner. You can optionally filter the results with a query.
355
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-query-api-key.html | Elasticsearch API documentation}
342
356
  */
343
357
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryApiKeysResponse>;
344
358
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryApiKeysResponse, unknown>>;
345
359
  queryApiKeys(this: That, params?: T.SecurityQueryApiKeysRequest | TB.SecurityQueryApiKeysRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryApiKeysResponse>;
346
360
  /**
347
- * Retrieves information for Users using a subset of query DSL
348
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-query-user.html | Elasticsearch API documentation}
361
+ * Retrieves 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.15/security-api-query-role.html | Elasticsearch API documentation}
363
+ */
364
+ queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryRoleResponse>;
365
+ queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryRoleResponse, unknown>>;
366
+ queryRole(this: That, params?: T.SecurityQueryRoleRequest | TB.SecurityQueryRoleRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryRoleResponse>;
367
+ /**
368
+ * Retrieves 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.15/security-api-query-user.html | Elasticsearch API documentation}
349
370
  */
350
- queryUser(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
351
- queryUser(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
352
- queryUser(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
371
+ queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityQueryUserResponse>;
372
+ queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityQueryUserResponse, unknown>>;
373
+ queryUser(this: That, params?: T.SecurityQueryUserRequest | TB.SecurityQueryUserRequest, options?: TransportRequestOptions): Promise<T.SecurityQueryUserResponse>;
353
374
  /**
354
- * Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair
355
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-authenticate.html | Elasticsearch API documentation}
375
+ * Submits a SAML Response message to Elasticsearch for consumption.
376
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-saml-authenticate.html | Elasticsearch API documentation}
356
377
  */
357
378
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlAuthenticateResponse>;
358
379
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlAuthenticateResponse, unknown>>;
359
380
  samlAuthenticate(this: That, params: T.SecuritySamlAuthenticateRequest | TB.SecuritySamlAuthenticateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlAuthenticateResponse>;
360
381
  /**
361
- * Verifies the logout response sent from the SAML IdP
362
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-complete-logout.html | Elasticsearch API documentation}
382
+ * Verifies the logout response sent from the SAML IdP.
383
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-saml-complete-logout.html | Elasticsearch API documentation}
363
384
  */
364
385
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlCompleteLogoutResponse>;
365
386
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlCompleteLogoutResponse, unknown>>;
366
387
  samlCompleteLogout(this: That, params: T.SecuritySamlCompleteLogoutRequest | TB.SecuritySamlCompleteLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlCompleteLogoutResponse>;
367
388
  /**
368
- * Consumes a SAML LogoutRequest
369
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-invalidate.html | Elasticsearch API documentation}
389
+ * Submits a SAML LogoutRequest message to Elasticsearch for consumption.
390
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-saml-invalidate.html | Elasticsearch API documentation}
370
391
  */
371
392
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlInvalidateResponse>;
372
393
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlInvalidateResponse, unknown>>;
373
394
  samlInvalidate(this: That, params: T.SecuritySamlInvalidateRequest | TB.SecuritySamlInvalidateRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlInvalidateResponse>;
374
395
  /**
375
- * Invalidates an access token and a refresh token that were generated via the SAML Authenticate API
376
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-logout.html | Elasticsearch API documentation}
396
+ * Submits a request to invalidate an access token and refresh token.
397
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-saml-logout.html | Elasticsearch API documentation}
377
398
  */
378
399
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlLogoutResponse>;
379
400
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlLogoutResponse, unknown>>;
380
401
  samlLogout(this: That, params: T.SecuritySamlLogoutRequest | TB.SecuritySamlLogoutRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlLogoutResponse>;
381
402
  /**
382
- * Creates a SAML authentication request
383
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
403
+ * 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.15/security-api-saml-prepare-authentication.html | Elasticsearch API documentation}
384
405
  */
385
406
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
386
407
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlPrepareAuthenticationResponse, unknown>>;
387
408
  samlPrepareAuthentication(this: That, params?: T.SecuritySamlPrepareAuthenticationRequest | TB.SecuritySamlPrepareAuthenticationRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlPrepareAuthenticationResponse>;
388
409
  /**
389
- * Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider
390
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
410
+ * Generate SAML metadata for a SAML 2.0 Service Provider.
411
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-saml-sp-metadata.html | Elasticsearch API documentation}
391
412
  */
392
413
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
393
414
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySamlServiceProviderMetadataResponse, unknown>>;
394
415
  samlServiceProviderMetadata(this: That, params: T.SecuritySamlServiceProviderMetadataRequest | TB.SecuritySamlServiceProviderMetadataRequest, options?: TransportRequestOptions): Promise<T.SecuritySamlServiceProviderMetadataResponse>;
395
416
  /**
396
417
  * Get suggestions for user profiles that match specified search criteria.
397
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-suggest-user-profile.html | Elasticsearch API documentation}
418
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-suggest-user-profile.html | Elasticsearch API documentation}
398
419
  */
399
420
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>;
400
421
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>;
401
422
  suggestUserProfiles(this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>;
402
423
  /**
403
- * Updates attributes of an existing API key.
404
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-update-api-key.html | Elasticsearch API documentation}
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.15/security-api-update-api-key.html | Elasticsearch API documentation}
405
426
  */
406
427
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateApiKeyResponse>;
407
428
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateApiKeyResponse, unknown>>;
408
429
  updateApiKey(this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>;
409
430
  /**
410
431
  * Updates attributes of an existing cross-cluster API key.
411
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
432
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-update-cross-cluster-api-key.html | Elasticsearch API documentation}
412
433
  */
413
434
  updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
414
435
  updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
415
436
  updateCrossClusterApiKey(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
416
437
  /**
417
438
  * Update settings for the security system index
418
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-update-settings.html | Elasticsearch API documentation}
439
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-update-settings.html | Elasticsearch API documentation}
419
440
  */
420
441
  updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>;
421
442
  updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>;
422
443
  updateSettings(this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>;
423
444
  /**
424
- * Update application specific data for the user profile of the given unique ID.
425
- * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.14/security-api-update-user-profile-data.html | Elasticsearch API documentation}
445
+ * Updates specific data for the user profile that's associated with the specified unique ID.
446
+ * @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.15/security-api-update-user-profile-data.html | Elasticsearch API documentation}
426
447
  */
427
448
  updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>;
428
449
  updateUserProfileData(this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>;