elasticsearch 8.17.2__py3-none-any.whl → 8.18.0__py3-none-any.whl

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 (135) hide show
  1. elasticsearch/_async/client/__init__.py +174 -79
  2. elasticsearch/_async/client/_base.py +0 -1
  3. elasticsearch/_async/client/async_search.py +12 -8
  4. elasticsearch/_async/client/autoscaling.py +4 -4
  5. elasticsearch/_async/client/cat.py +26 -26
  6. elasticsearch/_async/client/ccr.py +186 -72
  7. elasticsearch/_async/client/cluster.py +38 -19
  8. elasticsearch/_async/client/connector.py +30 -30
  9. elasticsearch/_async/client/dangling_indices.py +3 -3
  10. elasticsearch/_async/client/enrich.py +26 -5
  11. elasticsearch/_async/client/eql.py +32 -4
  12. elasticsearch/_async/client/esql.py +62 -6
  13. elasticsearch/_async/client/features.py +12 -2
  14. elasticsearch/_async/client/fleet.py +8 -2
  15. elasticsearch/_async/client/graph.py +1 -1
  16. elasticsearch/_async/client/ilm.py +23 -22
  17. elasticsearch/_async/client/indices.py +424 -132
  18. elasticsearch/_async/client/inference.py +1853 -115
  19. elasticsearch/_async/client/ingest.py +32 -38
  20. elasticsearch/_async/client/license.py +51 -16
  21. elasticsearch/_async/client/logstash.py +3 -3
  22. elasticsearch/_async/client/migration.py +3 -3
  23. elasticsearch/_async/client/ml.py +141 -112
  24. elasticsearch/_async/client/monitoring.py +1 -1
  25. elasticsearch/_async/client/nodes.py +9 -27
  26. elasticsearch/_async/client/query_rules.py +8 -8
  27. elasticsearch/_async/client/rollup.py +8 -8
  28. elasticsearch/_async/client/search_application.py +13 -13
  29. elasticsearch/_async/client/searchable_snapshots.py +4 -4
  30. elasticsearch/_async/client/security.py +71 -71
  31. elasticsearch/_async/client/shutdown.py +3 -10
  32. elasticsearch/_async/client/simulate.py +6 -6
  33. elasticsearch/_async/client/slm.py +9 -9
  34. elasticsearch/_async/client/snapshot.py +13 -17
  35. elasticsearch/_async/client/sql.py +6 -6
  36. elasticsearch/_async/client/ssl.py +1 -1
  37. elasticsearch/_async/client/synonyms.py +7 -7
  38. elasticsearch/_async/client/tasks.py +3 -9
  39. elasticsearch/_async/client/text_structure.py +4 -4
  40. elasticsearch/_async/client/transform.py +30 -28
  41. elasticsearch/_async/client/watcher.py +22 -14
  42. elasticsearch/_async/client/xpack.py +2 -2
  43. elasticsearch/_async/helpers.py +0 -1
  44. elasticsearch/_sync/client/__init__.py +174 -79
  45. elasticsearch/_sync/client/_base.py +0 -1
  46. elasticsearch/_sync/client/async_search.py +12 -8
  47. elasticsearch/_sync/client/autoscaling.py +4 -4
  48. elasticsearch/_sync/client/cat.py +26 -26
  49. elasticsearch/_sync/client/ccr.py +186 -72
  50. elasticsearch/_sync/client/cluster.py +38 -19
  51. elasticsearch/_sync/client/connector.py +30 -30
  52. elasticsearch/_sync/client/dangling_indices.py +3 -3
  53. elasticsearch/_sync/client/enrich.py +26 -5
  54. elasticsearch/_sync/client/eql.py +32 -4
  55. elasticsearch/_sync/client/esql.py +62 -6
  56. elasticsearch/_sync/client/features.py +12 -2
  57. elasticsearch/_sync/client/fleet.py +8 -2
  58. elasticsearch/_sync/client/graph.py +1 -1
  59. elasticsearch/_sync/client/ilm.py +23 -22
  60. elasticsearch/_sync/client/indices.py +424 -132
  61. elasticsearch/_sync/client/inference.py +1853 -115
  62. elasticsearch/_sync/client/ingest.py +32 -38
  63. elasticsearch/_sync/client/license.py +51 -16
  64. elasticsearch/_sync/client/logstash.py +3 -3
  65. elasticsearch/_sync/client/migration.py +3 -3
  66. elasticsearch/_sync/client/ml.py +141 -112
  67. elasticsearch/_sync/client/monitoring.py +1 -1
  68. elasticsearch/_sync/client/nodes.py +9 -27
  69. elasticsearch/_sync/client/query_rules.py +8 -8
  70. elasticsearch/_sync/client/rollup.py +8 -8
  71. elasticsearch/_sync/client/search_application.py +13 -13
  72. elasticsearch/_sync/client/searchable_snapshots.py +4 -4
  73. elasticsearch/_sync/client/security.py +71 -71
  74. elasticsearch/_sync/client/shutdown.py +3 -10
  75. elasticsearch/_sync/client/simulate.py +6 -6
  76. elasticsearch/_sync/client/slm.py +9 -9
  77. elasticsearch/_sync/client/snapshot.py +13 -17
  78. elasticsearch/_sync/client/sql.py +6 -6
  79. elasticsearch/_sync/client/ssl.py +1 -1
  80. elasticsearch/_sync/client/synonyms.py +7 -7
  81. elasticsearch/_sync/client/tasks.py +3 -9
  82. elasticsearch/_sync/client/text_structure.py +4 -4
  83. elasticsearch/_sync/client/transform.py +30 -28
  84. elasticsearch/_sync/client/utils.py +0 -3
  85. elasticsearch/_sync/client/watcher.py +22 -14
  86. elasticsearch/_sync/client/xpack.py +2 -2
  87. elasticsearch/_version.py +1 -1
  88. elasticsearch/dsl/__init__.py +203 -0
  89. elasticsearch/dsl/_async/__init__.py +16 -0
  90. elasticsearch/dsl/_async/document.py +522 -0
  91. elasticsearch/dsl/_async/faceted_search.py +50 -0
  92. elasticsearch/dsl/_async/index.py +639 -0
  93. elasticsearch/dsl/_async/mapping.py +49 -0
  94. elasticsearch/dsl/_async/search.py +233 -0
  95. elasticsearch/dsl/_async/update_by_query.py +47 -0
  96. elasticsearch/dsl/_sync/__init__.py +16 -0
  97. elasticsearch/dsl/_sync/document.py +514 -0
  98. elasticsearch/dsl/_sync/faceted_search.py +50 -0
  99. elasticsearch/dsl/_sync/index.py +597 -0
  100. elasticsearch/dsl/_sync/mapping.py +49 -0
  101. elasticsearch/dsl/_sync/search.py +226 -0
  102. elasticsearch/dsl/_sync/update_by_query.py +45 -0
  103. elasticsearch/dsl/aggs.py +3730 -0
  104. elasticsearch/dsl/analysis.py +341 -0
  105. elasticsearch/dsl/async_connections.py +37 -0
  106. elasticsearch/dsl/connections.py +142 -0
  107. elasticsearch/dsl/document.py +20 -0
  108. elasticsearch/dsl/document_base.py +444 -0
  109. elasticsearch/dsl/exceptions.py +32 -0
  110. elasticsearch/dsl/faceted_search.py +28 -0
  111. elasticsearch/dsl/faceted_search_base.py +489 -0
  112. elasticsearch/dsl/field.py +4254 -0
  113. elasticsearch/dsl/function.py +180 -0
  114. elasticsearch/dsl/index.py +23 -0
  115. elasticsearch/dsl/index_base.py +178 -0
  116. elasticsearch/dsl/mapping.py +19 -0
  117. elasticsearch/dsl/mapping_base.py +219 -0
  118. elasticsearch/dsl/query.py +2816 -0
  119. elasticsearch/dsl/response/__init__.py +388 -0
  120. elasticsearch/dsl/response/aggs.py +100 -0
  121. elasticsearch/dsl/response/hit.py +53 -0
  122. elasticsearch/dsl/search.py +20 -0
  123. elasticsearch/dsl/search_base.py +1040 -0
  124. elasticsearch/dsl/serializer.py +34 -0
  125. elasticsearch/dsl/types.py +6471 -0
  126. elasticsearch/dsl/update_by_query.py +19 -0
  127. elasticsearch/dsl/update_by_query_base.py +149 -0
  128. elasticsearch/dsl/utils.py +687 -0
  129. elasticsearch/dsl/wrappers.py +119 -0
  130. {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.0.dist-info}/METADATA +12 -2
  131. elasticsearch-8.18.0.dist-info/RECORD +161 -0
  132. elasticsearch-8.17.2.dist-info/RECORD +0 -119
  133. {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.0.dist-info}/WHEEL +0 -0
  134. {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.0.dist-info}/licenses/LICENSE +0 -0
  135. {elasticsearch-8.17.2.dist-info → elasticsearch-8.18.0.dist-info}/licenses/NOTICE +0 -0
@@ -58,7 +58,7 @@ class SecurityClient(NamespacedClient):
58
58
  Any updates do not change existing content for either the <code>labels</code> or <code>data</code> fields.</p>
59
59
 
60
60
 
61
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-activate-user-profile.html>`_
61
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-activate-user-profile.html>`_
62
62
 
63
63
  :param grant_type: The type of grant.
64
64
  :param access_token: The user's Elasticsearch access token or JWT. Both `access`
@@ -124,7 +124,7 @@ class SecurityClient(NamespacedClient):
124
124
  If the user cannot be authenticated, this API returns a 401 status code.</p>
125
125
 
126
126
 
127
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-authenticate.html>`_
127
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-authenticate.html>`_
128
128
  """
129
129
  __path_parts: t.Dict[str, str] = {}
130
130
  __path = "/_security/_authenticate"
@@ -171,7 +171,7 @@ class SecurityClient(NamespacedClient):
171
171
  The bulk delete roles API cannot delete roles that are defined in roles files.</p>
172
172
 
173
173
 
174
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-delete-role.html>`_
174
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-bulk-delete-role.html>`_
175
175
 
176
176
  :param names: An array of role names to delete
177
177
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -232,7 +232,7 @@ class SecurityClient(NamespacedClient):
232
232
  The bulk create or update roles API cannot update roles that are defined in roles files.</p>
233
233
 
234
234
 
235
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-put-role.html>`_
235
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-bulk-put-role.html>`_
236
236
 
237
237
  :param roles: A dictionary of role name to RoleDescriptor objects to add or update
238
238
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -300,7 +300,7 @@ class SecurityClient(NamespacedClient):
300
300
  <p>A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.</p>
301
301
 
302
302
 
303
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-bulk-update-api-keys.html>`_
303
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-bulk-update-api-keys.html>`_
304
304
 
305
305
  :param ids: The API key identifiers.
306
306
  :param expiration: Expiration time for the API keys. By default, API keys never
@@ -378,7 +378,7 @@ class SecurityClient(NamespacedClient):
378
378
  <p>Change the passwords of users in the native realm and built-in users.</p>
379
379
 
380
380
 
381
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-change-password.html>`_
381
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-change-password.html>`_
382
382
 
383
383
  :param username: The user whose password you want to change. If you do not specify
384
384
  this parameter, the password is changed for the current user.
@@ -445,7 +445,7 @@ class SecurityClient(NamespacedClient):
445
445
  The cache is also automatically cleared on state changes of the security index.</p>
446
446
 
447
447
 
448
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-api-key-cache.html>`_
448
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-clear-api-key-cache.html>`_
449
449
 
450
450
  :param ids: Comma-separated list of API key IDs to evict from the API key cache.
451
451
  To evict all API keys, use `*`. Does not support other wildcard patterns.
@@ -491,7 +491,7 @@ class SecurityClient(NamespacedClient):
491
491
  The cache is also automatically cleared for applications that have their privileges updated.</p>
492
492
 
493
493
 
494
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-privilege-cache.html>`_
494
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-clear-privilege-cache.html>`_
495
495
 
496
496
  :param application: A comma-separated list of applications. To clear all applications,
497
497
  use an asterism (`*`). It does not support other wildcard patterns.
@@ -541,7 +541,7 @@ class SecurityClient(NamespacedClient):
541
541
  For more information, refer to the documentation about controlling the user cache.</p>
542
542
 
543
543
 
544
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-cache.html>`_
544
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-clear-cache.html>`_
545
545
 
546
546
  :param realms: A comma-separated list of realms. To clear all realms, use an
547
547
  asterisk (`*`). It does not support other wildcard patterns.
@@ -591,7 +591,7 @@ class SecurityClient(NamespacedClient):
591
591
  <p>Evict roles from the native role cache.</p>
592
592
 
593
593
 
594
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-role-cache.html>`_
594
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-clear-role-cache.html>`_
595
595
 
596
596
  :param name: A comma-separated list of roles to evict from the role cache. To
597
597
  evict all roles, use an asterisk (`*`). It does not support other wildcard
@@ -643,7 +643,7 @@ class SecurityClient(NamespacedClient):
643
643
  The cache for tokens backed by the <code>service_tokens</code> file is cleared automatically on file changes.</p>
644
644
 
645
645
 
646
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-clear-service-token-caches.html>`_
646
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-clear-service-token-caches.html>`_
647
647
 
648
648
  :param namespace: The namespace, which is a top-level grouping of service accounts.
649
649
  :param service: The name of the service, which must be unique within its namespace.
@@ -715,7 +715,7 @@ class SecurityClient(NamespacedClient):
715
715
  To configure or turn off the API key service, refer to API key service setting documentation.</p>
716
716
 
717
717
 
718
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-api-key.html>`_
718
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-create-api-key.html>`_
719
719
 
720
720
  :param expiration: The expiration time for the API key. By default, API keys
721
721
  never expire.
@@ -805,7 +805,7 @@ class SecurityClient(NamespacedClient):
805
805
  Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.</p>
806
806
 
807
807
 
808
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-cross-cluster-api-key.html>`_
808
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-create-cross-cluster-api-key.html>`_
809
809
 
810
810
  :param access: The access to be granted to this API key. The access is composed
811
811
  of permissions for cross-cluster search and cross-cluster replication. At
@@ -880,7 +880,7 @@ class SecurityClient(NamespacedClient):
880
880
  You must actively delete them if they are no longer needed.</p>
881
881
 
882
882
 
883
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-create-service-token.html>`_
883
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-create-service-token.html>`_
884
884
 
885
885
  :param namespace: The name of the namespace, which is a top-level grouping of
886
886
  service accounts.
@@ -966,7 +966,7 @@ class SecurityClient(NamespacedClient):
966
966
  The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.</p>
967
967
 
968
968
 
969
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delegate-pki-authentication.html>`_
969
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delegate-pki-authentication.html>`_
970
970
 
971
971
  :param x509_certificate_chain: The X509Certificate chain, which is represented
972
972
  as an ordered string array. Each string in the array is a base64-encoded
@@ -1030,7 +1030,7 @@ class SecurityClient(NamespacedClient):
1030
1030
  </ul>
1031
1031
 
1032
1032
 
1033
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-privilege.html>`_
1033
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delete-privilege.html>`_
1034
1034
 
1035
1035
  :param application: The name of the application. Application privileges are always
1036
1036
  associated with exactly one application.
@@ -1093,7 +1093,7 @@ class SecurityClient(NamespacedClient):
1093
1093
  The delete roles API cannot remove roles that are defined in roles files.</p>
1094
1094
 
1095
1095
 
1096
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role.html>`_
1096
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delete-role.html>`_
1097
1097
 
1098
1098
  :param name: The name of the role.
1099
1099
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -1147,7 +1147,7 @@ class SecurityClient(NamespacedClient):
1147
1147
  The delete role mappings API cannot remove role mappings that are defined in role mapping files.</p>
1148
1148
 
1149
1149
 
1150
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-role-mapping.html>`_
1150
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delete-role-mapping.html>`_
1151
1151
 
1152
1152
  :param name: The distinct name that identifies the role mapping. The name is
1153
1153
  used solely as an identifier to facilitate interaction via the API; it does
@@ -1203,7 +1203,7 @@ class SecurityClient(NamespacedClient):
1203
1203
  <p>Delete service account tokens for a service in a specified namespace.</p>
1204
1204
 
1205
1205
 
1206
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-service-token.html>`_
1206
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delete-service-token.html>`_
1207
1207
 
1208
1208
  :param namespace: The namespace, which is a top-level grouping of service accounts.
1209
1209
  :param service: The service name.
@@ -1265,7 +1265,7 @@ class SecurityClient(NamespacedClient):
1265
1265
  <p>Delete users from the native realm.</p>
1266
1266
 
1267
1267
 
1268
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-delete-user.html>`_
1268
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-delete-user.html>`_
1269
1269
 
1270
1270
  :param username: An identifier for the user.
1271
1271
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -1319,7 +1319,7 @@ class SecurityClient(NamespacedClient):
1319
1319
  You can use this API to revoke a user's access to Elasticsearch.</p>
1320
1320
 
1321
1321
 
1322
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user.html>`_
1322
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-disable-user.html>`_
1323
1323
 
1324
1324
  :param username: An identifier for the user.
1325
1325
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -1376,7 +1376,7 @@ class SecurityClient(NamespacedClient):
1376
1376
  To re-enable a disabled user profile, use the enable user profile API .</p>
1377
1377
 
1378
1378
 
1379
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-disable-user-profile.html>`_
1379
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-disable-user-profile.html>`_
1380
1380
 
1381
1381
  :param uid: Unique identifier for the user profile.
1382
1382
  :param refresh: If 'true', Elasticsearch refreshes the affected shards to make
@@ -1429,7 +1429,7 @@ class SecurityClient(NamespacedClient):
1429
1429
  By default, when you create users, they are enabled.</p>
1430
1430
 
1431
1431
 
1432
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user.html>`_
1432
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-enable-user.html>`_
1433
1433
 
1434
1434
  :param username: An identifier for the user.
1435
1435
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -1486,7 +1486,7 @@ class SecurityClient(NamespacedClient):
1486
1486
  If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.</p>
1487
1487
 
1488
1488
 
1489
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-enable-user-profile.html>`_
1489
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-enable-user-profile.html>`_
1490
1490
 
1491
1491
  :param uid: A unique identifier for the user profile.
1492
1492
  :param refresh: If 'true', Elasticsearch refreshes the affected shards to make
@@ -1536,7 +1536,7 @@ class SecurityClient(NamespacedClient):
1536
1536
  Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.</p>
1537
1537
 
1538
1538
 
1539
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-kibana-enrollment.html>`_
1539
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-kibana-enrollment.html>`_
1540
1540
  """
1541
1541
  __path_parts: t.Dict[str, str] = {}
1542
1542
  __path = "/_security/enroll/kibana"
@@ -1577,7 +1577,7 @@ class SecurityClient(NamespacedClient):
1577
1577
  The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.</p>
1578
1578
 
1579
1579
 
1580
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-node-enrollment.html>`_
1580
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-node-enrollment.html>`_
1581
1581
  """
1582
1582
  __path_parts: t.Dict[str, str] = {}
1583
1583
  __path = "/_security/enroll/node"
@@ -1626,7 +1626,7 @@ class SecurityClient(NamespacedClient):
1626
1626
  If you have <code>read_security</code>, <code>manage_api_key</code> or greater privileges (including <code>manage_security</code>), this API returns all API keys regardless of ownership.</p>
1627
1627
 
1628
1628
 
1629
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-api-key.html>`_
1629
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-api-key.html>`_
1630
1630
 
1631
1631
  :param active_only: A boolean flag that can be used to query API keys that are
1632
1632
  currently active. An API key is considered active if it is neither invalidated,
@@ -1704,7 +1704,7 @@ class SecurityClient(NamespacedClient):
1704
1704
  <p>Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.</p>
1705
1705
 
1706
1706
 
1707
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-builtin-privileges.html>`_
1707
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-builtin-privileges.html>`_
1708
1708
  """
1709
1709
  __path_parts: t.Dict[str, str] = {}
1710
1710
  __path = "/_security/privilege/_builtin"
@@ -1749,7 +1749,7 @@ class SecurityClient(NamespacedClient):
1749
1749
  </ul>
1750
1750
 
1751
1751
 
1752
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-privileges.html>`_
1752
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-privileges.html>`_
1753
1753
 
1754
1754
  :param application: The name of the application. Application privileges are always
1755
1755
  associated with exactly one application. If you do not specify this parameter,
@@ -1805,7 +1805,7 @@ class SecurityClient(NamespacedClient):
1805
1805
  The get roles API cannot retrieve roles that are defined in roles files.</p>
1806
1806
 
1807
1807
 
1808
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-role.html>`_
1808
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-role.html>`_
1809
1809
 
1810
1810
  :param name: The name of the role. You can specify multiple roles as a comma-separated
1811
1811
  list. If you do not specify this parameter, the API returns information about
@@ -1856,7 +1856,7 @@ class SecurityClient(NamespacedClient):
1856
1856
  The get role mappings API cannot retrieve role mappings that are defined in role mapping files.</p>
1857
1857
 
1858
1858
 
1859
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-role-mapping.html>`_
1859
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-role-mapping.html>`_
1860
1860
 
1861
1861
  :param name: The distinct name that identifies the role mapping. The name is
1862
1862
  used solely as an identifier to facilitate interaction via the API; it does
@@ -1909,7 +1909,7 @@ class SecurityClient(NamespacedClient):
1909
1909
  <p>NOTE: Currently, only the <code>elastic/fleet-server</code> service account is available.</p>
1910
1910
 
1911
1911
 
1912
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-service-accounts.html>`_
1912
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-service-accounts.html>`_
1913
1913
 
1914
1914
  :param namespace: The name of the namespace. Omit this parameter to retrieve
1915
1915
  information about all service accounts. If you omit this parameter, you must
@@ -1967,7 +1967,7 @@ class SecurityClient(NamespacedClient):
1967
1967
  Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.</p>
1968
1968
 
1969
1969
 
1970
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-service-credentials.html>`_
1970
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-service-credentials.html>`_
1971
1971
 
1972
1972
  :param namespace: The name of the namespace.
1973
1973
  :param service: The service name.
@@ -2023,7 +2023,7 @@ class SecurityClient(NamespacedClient):
2023
2023
  </ul>
2024
2024
 
2025
2025
 
2026
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-settings.html>`_
2026
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-settings.html>`_
2027
2027
 
2028
2028
  :param master_timeout: Period to wait for a connection to the master node. If
2029
2029
  no response is received before the timeout expires, the request fails and
@@ -2099,7 +2099,7 @@ class SecurityClient(NamespacedClient):
2099
2099
  If you want to invalidate a token immediately, you can do so by using the invalidate token API.</p>
2100
2100
 
2101
2101
 
2102
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-token.html>`_
2102
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-token.html>`_
2103
2103
 
2104
2104
  :param grant_type: The type of grant. Supported grant types are: `password`,
2105
2105
  `_kerberos`, `client_credentials`, and `refresh_token`.
@@ -2173,7 +2173,7 @@ class SecurityClient(NamespacedClient):
2173
2173
  <p>Get information about users in the native realm and built-in users.</p>
2174
2174
 
2175
2175
 
2176
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user.html>`_
2176
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-user.html>`_
2177
2177
 
2178
2178
  :param username: An identifier for the user. You can specify multiple usernames
2179
2179
  as a comma-separated list. If you omit this parameter, the API retrieves
@@ -2231,7 +2231,7 @@ class SecurityClient(NamespacedClient):
2231
2231
  To check whether a user has a specific list of privileges, use the has privileges API.</p>
2232
2232
 
2233
2233
 
2234
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user-privileges.html>`_
2234
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-user-privileges.html>`_
2235
2235
 
2236
2236
  :param application: The name of the application. Application privileges are always
2237
2237
  associated with exactly one application. If you do not specify this parameter,
@@ -2288,7 +2288,7 @@ class SecurityClient(NamespacedClient):
2288
2288
  Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
2289
2289
 
2290
2290
 
2291
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-get-user-profile.html>`_
2291
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-get-user-profile.html>`_
2292
2292
 
2293
2293
  :param uid: A unique identifier for the user profile.
2294
2294
  :param data: A comma-separated list of filters for the `data` field of the profile
@@ -2372,7 +2372,7 @@ class SecurityClient(NamespacedClient):
2372
2372
  <p>By default, API keys never expire. You can specify expiration information when you create the API keys.</p>
2373
2373
 
2374
2374
 
2375
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-grant-api-key.html>`_
2375
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-grant-api-key.html>`_
2376
2376
 
2377
2377
  :param api_key: The API key.
2378
2378
  :param grant_type: The type of grant. Supported grant types are: `access_token`,
@@ -2519,7 +2519,7 @@ class SecurityClient(NamespacedClient):
2519
2519
  To check the privileges of other users, you must use the run as feature.</p>
2520
2520
 
2521
2521
 
2522
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-has-privileges.html>`_
2522
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-has-privileges.html>`_
2523
2523
 
2524
2524
  :param user: Username
2525
2525
  :param application:
@@ -2584,7 +2584,7 @@ class SecurityClient(NamespacedClient):
2584
2584
  Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
2585
2585
 
2586
2586
 
2587
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-has-privileges-user-profile.html>`_
2587
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-has-privileges-user-profile.html>`_
2588
2588
 
2589
2589
  :param privileges: An object containing all the privileges to be checked.
2590
2590
  :param uids: A list of profile IDs. The privileges are checked for associated
@@ -2658,7 +2658,7 @@ class SecurityClient(NamespacedClient):
2658
2658
  </ul>
2659
2659
 
2660
2660
 
2661
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-invalidate-api-key.html>`_
2661
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-invalidate-api-key.html>`_
2662
2662
 
2663
2663
  :param id:
2664
2664
  :param ids: A list of API key ids. This parameter cannot be used with any of
@@ -2742,7 +2742,7 @@ class SecurityClient(NamespacedClient):
2742
2742
  If none of these two are specified, then <code>realm_name</code> and/or <code>username</code> need to be specified.</p>
2743
2743
 
2744
2744
 
2745
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-invalidate-token.html>`_
2745
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-invalidate-token.html>`_
2746
2746
 
2747
2747
  :param realm_name: The name of an authentication realm. This parameter cannot
2748
2748
  be used with either `refresh_token` or `token`.
@@ -2810,7 +2810,7 @@ class SecurityClient(NamespacedClient):
2810
2810
  These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
2811
2811
 
2812
2812
 
2813
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-authenticate.html>`_
2813
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-oidc-authenticate.html>`_
2814
2814
 
2815
2815
  :param nonce: Associate a client session with an ID token and mitigate replay
2816
2816
  attacks. This value needs to be the same as the one that was provided to
@@ -2867,12 +2867,12 @@ class SecurityClient(NamespacedClient):
2867
2867
  )
2868
2868
 
2869
2869
  @_rewrite_parameters(
2870
- body_fields=("access_token", "refresh_token"),
2870
+ body_fields=("token", "refresh_token"),
2871
2871
  )
2872
2872
  async def oidc_logout(
2873
2873
  self,
2874
2874
  *,
2875
- access_token: t.Optional[str] = None,
2875
+ token: t.Optional[str] = None,
2876
2876
  error_trace: t.Optional[bool] = None,
2877
2877
  filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
2878
2878
  human: t.Optional[bool] = None,
@@ -2890,13 +2890,13 @@ class SecurityClient(NamespacedClient):
2890
2890
  These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
2891
2891
 
2892
2892
 
2893
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-logout.html>`_
2893
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-oidc-logout.html>`_
2894
2894
 
2895
- :param access_token: The access token to be invalidated.
2895
+ :param token: The access token to be invalidated.
2896
2896
  :param refresh_token: The refresh token to be invalidated.
2897
2897
  """
2898
- if access_token is None and body is None:
2899
- raise ValueError("Empty value passed for parameter 'access_token'")
2898
+ if token is None and body is None:
2899
+ raise ValueError("Empty value passed for parameter 'token'")
2900
2900
  __path_parts: t.Dict[str, str] = {}
2901
2901
  __path = "/_security/oidc/logout"
2902
2902
  __query: t.Dict[str, t.Any] = {}
@@ -2910,8 +2910,8 @@ class SecurityClient(NamespacedClient):
2910
2910
  if pretty is not None:
2911
2911
  __query["pretty"] = pretty
2912
2912
  if not __body:
2913
- if access_token is not None:
2914
- __body["access_token"] = access_token
2913
+ if token is not None:
2914
+ __body["token"] = token
2915
2915
  if refresh_token is not None:
2916
2916
  __body["refresh_token"] = refresh_token
2917
2917
  __headers = {"accept": "application/json", "content-type": "application/json"}
@@ -2952,7 +2952,7 @@ class SecurityClient(NamespacedClient):
2952
2952
  These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.</p>
2953
2953
 
2954
2954
 
2955
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-oidc-prepare-authentication.html>`_
2955
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-oidc-prepare-authentication.html>`_
2956
2956
 
2957
2957
  :param iss: In the case of a third party initiated single sign on, this is the
2958
2958
  issuer identifier for the OP that the RP is to send the authentication request
@@ -3048,7 +3048,7 @@ class SecurityClient(NamespacedClient):
3048
3048
  <p>Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: <code>/</code>, <code>*</code>, <code>:</code>.</p>
3049
3049
 
3050
3050
 
3051
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-privileges.html>`_
3051
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-put-privileges.html>`_
3052
3052
 
3053
3053
  :param privileges:
3054
3054
  :param refresh: If `true` (the default) then refresh the affected shards to make
@@ -3200,7 +3200,7 @@ class SecurityClient(NamespacedClient):
3200
3200
  File-based role management is not available in Elastic Serverless.</p>
3201
3201
 
3202
3202
 
3203
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-role.html>`_
3203
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-put-role.html>`_
3204
3204
 
3205
3205
  :param name: The name of the role.
3206
3206
  :param applications: A list of application privilege entries.
@@ -3332,7 +3332,7 @@ class SecurityClient(NamespacedClient):
3332
3332
  If the format of the template is set to &quot;json&quot; then the template is expected to produce a JSON string or an array of JSON strings for the role names.</p>
3333
3333
 
3334
3334
 
3335
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-role-mapping.html>`_
3335
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-put-role-mapping.html>`_
3336
3336
 
3337
3337
  :param name: The distinct name that identifies the role mapping. The name is
3338
3338
  used solely as an identifier to facilitate interaction via the API; it does
@@ -3434,7 +3434,7 @@ class SecurityClient(NamespacedClient):
3434
3434
  To change a user's password without updating any other fields, use the change password API.</p>
3435
3435
 
3436
3436
 
3437
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-put-user.html>`_
3437
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-put-user.html>`_
3438
3438
 
3439
3439
  :param username: An identifier for the user. NOTE: Usernames must be at least
3440
3440
  1 and no more than 507 characters. They can contain alphanumeric characters
@@ -3553,7 +3553,7 @@ class SecurityClient(NamespacedClient):
3553
3553
  If you have the <code>read_security</code>, <code>manage_api_key</code>, or greater privileges (including <code>manage_security</code>), this API returns all API keys regardless of ownership.</p>
3554
3554
 
3555
3555
 
3556
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-api-key.html>`_
3556
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-query-api-key.html>`_
3557
3557
 
3558
3558
  :param aggregations: Any aggregations to run over the corpus of returned API
3559
3559
  keys. Aggregations and queries work together. Aggregations are computed only
@@ -3696,7 +3696,7 @@ class SecurityClient(NamespacedClient):
3696
3696
  Also, the results can be paginated and sorted.</p>
3697
3697
 
3698
3698
 
3699
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-role.html>`_
3699
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-query-role.html>`_
3700
3700
 
3701
3701
  :param from_: The starting document offset. It must not be negative. By default,
3702
3702
  you cannot page through more than 10,000 hits using the `from` and `size`
@@ -3789,7 +3789,7 @@ class SecurityClient(NamespacedClient):
3789
3789
  This API is only for native users.</p>
3790
3790
 
3791
3791
 
3792
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-query-user.html>`_
3792
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-query-user.html>`_
3793
3793
 
3794
3794
  :param from_: The starting document offset. It must not be negative. By default,
3795
3795
  you cannot page through more than 10,000 hits using the `from` and `size`
@@ -3882,7 +3882,7 @@ class SecurityClient(NamespacedClient):
3882
3882
  This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.</p>
3883
3883
 
3884
3884
 
3885
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-authenticate.html>`_
3885
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-authenticate.html>`_
3886
3886
 
3887
3887
  :param content: The SAML response as it was sent by the user's browser, usually
3888
3888
  a Base64 encoded XML document.
@@ -3955,7 +3955,7 @@ class SecurityClient(NamespacedClient):
3955
3955
  The caller of this API must prepare the request accordingly so that this API can handle either of them.</p>
3956
3956
 
3957
3957
 
3958
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-complete-logout.html>`_
3958
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-complete-logout.html>`_
3959
3959
 
3960
3960
  :param ids: A JSON array with all the valid SAML Request Ids that the caller
3961
3961
  of the API has for the current user.
@@ -4031,7 +4031,7 @@ class SecurityClient(NamespacedClient):
4031
4031
  Thus the user can be redirected back to their IdP.</p>
4032
4032
 
4033
4033
 
4034
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-invalidate.html>`_
4034
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-invalidate.html>`_
4035
4035
 
4036
4036
  :param query_string: The query part of the URL that the user was redirected to
4037
4037
  by the SAML IdP to initiate the Single Logout. This query should include
@@ -4106,7 +4106,7 @@ class SecurityClient(NamespacedClient):
4106
4106
  If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).</p>
4107
4107
 
4108
4108
 
4109
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-logout.html>`_
4109
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-logout.html>`_
4110
4110
 
4111
4111
  :param token: The access token that was returned as a response to calling the
4112
4112
  SAML authenticate API. Alternatively, the most recent token that was received
@@ -4176,7 +4176,7 @@ class SecurityClient(NamespacedClient):
4176
4176
  The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.</p>
4177
4177
 
4178
4178
 
4179
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-prepare-authentication.html>`_
4179
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-prepare-authentication.html>`_
4180
4180
 
4181
4181
  :param acs: The Assertion Consumer Service URL that matches the one of the SAML
4182
4182
  realms in Elasticsearch. The realm is used to generate the authentication
@@ -4237,7 +4237,7 @@ class SecurityClient(NamespacedClient):
4237
4237
  This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.</p>
4238
4238
 
4239
4239
 
4240
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-saml-sp-metadata.html>`_
4240
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-saml-sp-metadata.html>`_
4241
4241
 
4242
4242
  :param realm_name: The name of the SAML realm in Elasticsearch.
4243
4243
  """
@@ -4290,7 +4290,7 @@ class SecurityClient(NamespacedClient):
4290
4290
  Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
4291
4291
 
4292
4292
 
4293
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-suggest-user-profile.html>`_
4293
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-suggest-user-profile.html>`_
4294
4294
 
4295
4295
  :param data: A comma-separated list of filters for the `data` field of the profile
4296
4296
  document. To return all content use `data=*`. To return a subset of content,
@@ -4377,7 +4377,7 @@ class SecurityClient(NamespacedClient):
4377
4377
  This change can occur if the owner user's permissions have changed since the API key was created or last modified.</p>
4378
4378
 
4379
4379
 
4380
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-api-key.html>`_
4380
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-update-api-key.html>`_
4381
4381
 
4382
4382
  :param id: The ID of the API key to update.
4383
4383
  :param expiration: The expiration time for the API key. By default, API keys
@@ -4465,7 +4465,7 @@ class SecurityClient(NamespacedClient):
4465
4465
  <p>NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.</p>
4466
4466
 
4467
4467
 
4468
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-cross-cluster-api-key.html>`_
4468
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-update-cross-cluster-api-key.html>`_
4469
4469
 
4470
4470
  :param id: The ID of the cross-cluster API key to update.
4471
4471
  :param access: The access to be granted to this API key. The access is composed
@@ -4544,7 +4544,7 @@ class SecurityClient(NamespacedClient):
4544
4544
  This API does not yet support configuring the settings for indices before they are in use.</p>
4545
4545
 
4546
4546
 
4547
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-settings.html>`_
4547
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-update-settings.html>`_
4548
4548
 
4549
4549
  :param master_timeout: The period to wait for a connection to the master node.
4550
4550
  If no response is received before the timeout expires, the request fails
@@ -4629,7 +4629,7 @@ class SecurityClient(NamespacedClient):
4629
4629
  The <code>update_profile_data</code> global privilege grants privileges for updating only the allowed namespaces.</p>
4630
4630
 
4631
4631
 
4632
- `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-update-user-profile-data.html>`_
4632
+ `<https://www.elastic.co/guide/en/elasticsearch/reference/8.18/security-api-update-user-profile-data.html>`_
4633
4633
 
4634
4634
  :param uid: A unique identifier for the user profile.
4635
4635
  :param data: Non-searchable data that you want to associate with the user profile.