elasticsearch 8.18.0__py3-none-any.whl → 8.19.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.
- elasticsearch/_async/client/__init__.py +56 -76
- elasticsearch/_async/client/async_search.py +5 -9
- elasticsearch/_async/client/autoscaling.py +4 -4
- elasticsearch/_async/client/cat.py +620 -65
- elasticsearch/_async/client/ccr.py +13 -13
- elasticsearch/_async/client/cluster.py +33 -24
- elasticsearch/_async/client/connector.py +30 -30
- elasticsearch/_async/client/dangling_indices.py +3 -3
- elasticsearch/_async/client/enrich.py +5 -5
- elasticsearch/_async/client/eql.py +13 -5
- elasticsearch/_async/client/esql.py +38 -9
- elasticsearch/_async/client/features.py +2 -2
- elasticsearch/_async/client/fleet.py +13 -13
- elasticsearch/_async/client/graph.py +1 -1
- elasticsearch/_async/client/ilm.py +11 -11
- elasticsearch/_async/client/indices.py +131 -82
- elasticsearch/_async/client/inference.py +516 -110
- elasticsearch/_async/client/ingest.py +9 -16
- elasticsearch/_async/client/license.py +11 -11
- elasticsearch/_async/client/logstash.py +3 -3
- elasticsearch/_async/client/migration.py +3 -3
- elasticsearch/_async/client/ml.py +81 -93
- elasticsearch/_async/client/nodes.py +9 -8
- elasticsearch/_async/client/query_rules.py +8 -8
- elasticsearch/_async/client/rollup.py +8 -8
- elasticsearch/_async/client/search_application.py +10 -10
- elasticsearch/_async/client/searchable_snapshots.py +4 -4
- elasticsearch/_async/client/security.py +72 -80
- elasticsearch/_async/client/shutdown.py +3 -3
- elasticsearch/_async/client/simulate.py +1 -1
- elasticsearch/_async/client/slm.py +9 -9
- elasticsearch/_async/client/snapshot.py +19 -13
- elasticsearch/_async/client/sql.py +6 -6
- elasticsearch/_async/client/ssl.py +1 -1
- elasticsearch/_async/client/synonyms.py +7 -7
- elasticsearch/_async/client/tasks.py +3 -3
- elasticsearch/_async/client/text_structure.py +4 -4
- elasticsearch/_async/client/transform.py +11 -11
- elasticsearch/_async/client/watcher.py +13 -13
- elasticsearch/_async/client/xpack.py +2 -2
- elasticsearch/_sync/client/__init__.py +56 -76
- elasticsearch/_sync/client/async_search.py +5 -9
- elasticsearch/_sync/client/autoscaling.py +4 -4
- elasticsearch/_sync/client/cat.py +620 -65
- elasticsearch/_sync/client/ccr.py +13 -13
- elasticsearch/_sync/client/cluster.py +33 -24
- elasticsearch/_sync/client/connector.py +30 -30
- elasticsearch/_sync/client/dangling_indices.py +3 -3
- elasticsearch/_sync/client/enrich.py +5 -5
- elasticsearch/_sync/client/eql.py +13 -5
- elasticsearch/_sync/client/esql.py +38 -9
- elasticsearch/_sync/client/features.py +2 -2
- elasticsearch/_sync/client/fleet.py +13 -13
- elasticsearch/_sync/client/graph.py +1 -1
- elasticsearch/_sync/client/ilm.py +11 -11
- elasticsearch/_sync/client/indices.py +131 -82
- elasticsearch/_sync/client/inference.py +516 -110
- elasticsearch/_sync/client/ingest.py +9 -16
- elasticsearch/_sync/client/license.py +11 -11
- elasticsearch/_sync/client/logstash.py +3 -3
- elasticsearch/_sync/client/migration.py +3 -3
- elasticsearch/_sync/client/ml.py +81 -93
- elasticsearch/_sync/client/nodes.py +9 -8
- elasticsearch/_sync/client/query_rules.py +8 -8
- elasticsearch/_sync/client/rollup.py +8 -8
- elasticsearch/_sync/client/search_application.py +10 -10
- elasticsearch/_sync/client/searchable_snapshots.py +4 -4
- elasticsearch/_sync/client/security.py +72 -80
- elasticsearch/_sync/client/shutdown.py +3 -3
- elasticsearch/_sync/client/simulate.py +1 -1
- elasticsearch/_sync/client/slm.py +9 -9
- elasticsearch/_sync/client/snapshot.py +19 -13
- elasticsearch/_sync/client/sql.py +6 -6
- elasticsearch/_sync/client/ssl.py +1 -1
- elasticsearch/_sync/client/synonyms.py +7 -7
- elasticsearch/_sync/client/tasks.py +3 -3
- elasticsearch/_sync/client/text_structure.py +4 -4
- elasticsearch/_sync/client/transform.py +11 -11
- elasticsearch/_sync/client/watcher.py +13 -13
- elasticsearch/_sync/client/xpack.py +2 -2
- elasticsearch/_version.py +1 -1
- elasticsearch/compat.py +5 -0
- elasticsearch/dsl/__init__.py +2 -1
- elasticsearch/dsl/_async/document.py +1 -1
- elasticsearch/dsl/_sync/document.py +1 -1
- elasticsearch/dsl/aggs.py +2 -3
- elasticsearch/dsl/document_base.py +176 -16
- elasticsearch/dsl/field.py +361 -38
- elasticsearch/dsl/query.py +55 -4
- elasticsearch/dsl/types.py +151 -22
- elasticsearch/dsl/utils.py +1 -1
- elasticsearch/esql/__init__.py +18 -0
- elasticsearch/esql/esql.py +1105 -0
- elasticsearch/esql/functions.py +1738 -0
- elasticsearch/exceptions.py +2 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/METADATA +1 -1
- elasticsearch-8.19.0.dist-info/RECORD +164 -0
- elasticsearch-8.18.0.dist-info/RECORD +0 -161
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/WHEEL +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.0.dist-info}/licenses/LICENSE +0 -0
- {elasticsearch-8.18.0.dist-info → elasticsearch-8.19.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.
|
|
61
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
127
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
174
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
235
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
303
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
381
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
448
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
494
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
544
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
594
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
646
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
718
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
808
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
883
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
969
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1033
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1096
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1150
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1206
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1268
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1322
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1379
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1432
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1489
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1539
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1580
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1629
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1707
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1752
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1808
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1859
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1912
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
1970
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
2026
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
2102
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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.
|
|
2176
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/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
|
|
@@ -2213,13 +2213,10 @@ class SecurityClient(NamespacedClient):
|
|
|
2213
2213
|
def get_user_privileges(
|
|
2214
2214
|
self,
|
|
2215
2215
|
*,
|
|
2216
|
-
application: t.Optional[str] = None,
|
|
2217
2216
|
error_trace: t.Optional[bool] = None,
|
|
2218
2217
|
filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
|
|
2219
2218
|
human: t.Optional[bool] = None,
|
|
2220
2219
|
pretty: t.Optional[bool] = None,
|
|
2221
|
-
priviledge: t.Optional[str] = None,
|
|
2222
|
-
username: t.Optional[t.Union[None, str]] = None,
|
|
2223
2220
|
) -> ObjectApiResponse[t.Any]:
|
|
2224
2221
|
"""
|
|
2225
2222
|
.. raw:: html
|
|
@@ -2231,20 +2228,11 @@ class SecurityClient(NamespacedClient):
|
|
|
2231
2228
|
To check whether a user has a specific list of privileges, use the has privileges API.</p>
|
|
2232
2229
|
|
|
2233
2230
|
|
|
2234
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2235
|
-
|
|
2236
|
-
:param application: The name of the application. Application privileges are always
|
|
2237
|
-
associated with exactly one application. If you do not specify this parameter,
|
|
2238
|
-
the API returns information about all privileges for all applications.
|
|
2239
|
-
:param priviledge: The name of the privilege. If you do not specify this parameter,
|
|
2240
|
-
the API returns information about all privileges for the requested application.
|
|
2241
|
-
:param username:
|
|
2231
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-user-privileges.html>`_
|
|
2242
2232
|
"""
|
|
2243
2233
|
__path_parts: t.Dict[str, str] = {}
|
|
2244
2234
|
__path = "/_security/user/_privileges"
|
|
2245
2235
|
__query: t.Dict[str, t.Any] = {}
|
|
2246
|
-
if application is not None:
|
|
2247
|
-
__query["application"] = application
|
|
2248
2236
|
if error_trace is not None:
|
|
2249
2237
|
__query["error_trace"] = error_trace
|
|
2250
2238
|
if filter_path is not None:
|
|
@@ -2253,10 +2241,6 @@ class SecurityClient(NamespacedClient):
|
|
|
2253
2241
|
__query["human"] = human
|
|
2254
2242
|
if pretty is not None:
|
|
2255
2243
|
__query["pretty"] = pretty
|
|
2256
|
-
if priviledge is not None:
|
|
2257
|
-
__query["priviledge"] = priviledge
|
|
2258
|
-
if username is not None:
|
|
2259
|
-
__query["username"] = username
|
|
2260
2244
|
__headers = {"accept": "application/json"}
|
|
2261
2245
|
return self.perform_request( # type: ignore[return-value]
|
|
2262
2246
|
"GET",
|
|
@@ -2288,7 +2272,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2288
2272
|
Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
|
|
2289
2273
|
|
|
2290
2274
|
|
|
2291
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2275
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-user-profile.html>`_
|
|
2292
2276
|
|
|
2293
2277
|
:param uid: A unique identifier for the user profile.
|
|
2294
2278
|
:param data: A comma-separated list of filters for the `data` field of the profile
|
|
@@ -2345,6 +2329,9 @@ class SecurityClient(NamespacedClient):
|
|
|
2345
2329
|
human: t.Optional[bool] = None,
|
|
2346
2330
|
password: t.Optional[str] = None,
|
|
2347
2331
|
pretty: t.Optional[bool] = None,
|
|
2332
|
+
refresh: t.Optional[
|
|
2333
|
+
t.Union[bool, str, t.Literal["false", "true", "wait_for"]]
|
|
2334
|
+
] = None,
|
|
2348
2335
|
run_as: t.Optional[str] = None,
|
|
2349
2336
|
username: t.Optional[str] = None,
|
|
2350
2337
|
body: t.Optional[t.Dict[str, t.Any]] = None,
|
|
@@ -2372,7 +2359,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2372
2359
|
<p>By default, API keys never expire. You can specify expiration information when you create the API keys.</p>
|
|
2373
2360
|
|
|
2374
2361
|
|
|
2375
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2362
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-grant-api-key.html>`_
|
|
2376
2363
|
|
|
2377
2364
|
:param api_key: The API key.
|
|
2378
2365
|
:param grant_type: The type of grant. Supported grant types are: `access_token`,
|
|
@@ -2382,6 +2369,9 @@ class SecurityClient(NamespacedClient):
|
|
|
2382
2369
|
types.
|
|
2383
2370
|
:param password: The user's password. If you specify the `password` grant type,
|
|
2384
2371
|
this parameter is required. It is not valid with other grant types.
|
|
2372
|
+
:param refresh: If 'true', Elasticsearch refreshes the affected shards to make
|
|
2373
|
+
this operation visible to search. If 'wait_for', it waits for a refresh to
|
|
2374
|
+
make this operation visible to search. If 'false', nothing is done with refreshes.
|
|
2385
2375
|
:param run_as: The name of the user to be impersonated.
|
|
2386
2376
|
:param username: The user name that identifies the user. If you specify the `password`
|
|
2387
2377
|
grant type, this parameter is required. It is not valid with other grant
|
|
@@ -2403,6 +2393,8 @@ class SecurityClient(NamespacedClient):
|
|
|
2403
2393
|
__query["human"] = human
|
|
2404
2394
|
if pretty is not None:
|
|
2405
2395
|
__query["pretty"] = pretty
|
|
2396
|
+
if refresh is not None:
|
|
2397
|
+
__query["refresh"] = refresh
|
|
2406
2398
|
if not __body:
|
|
2407
2399
|
if api_key is not None:
|
|
2408
2400
|
__body["api_key"] = api_key
|
|
@@ -2519,7 +2511,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2519
2511
|
To check the privileges of other users, you must use the run as feature.</p>
|
|
2520
2512
|
|
|
2521
2513
|
|
|
2522
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2514
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges.html>`_
|
|
2523
2515
|
|
|
2524
2516
|
:param user: Username
|
|
2525
2517
|
:param application:
|
|
@@ -2584,7 +2576,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2584
2576
|
Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
|
|
2585
2577
|
|
|
2586
2578
|
|
|
2587
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2579
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-has-privileges-user-profile.html>`_
|
|
2588
2580
|
|
|
2589
2581
|
:param privileges: An object containing all the privileges to be checked.
|
|
2590
2582
|
:param uids: A list of profile IDs. The privileges are checked for associated
|
|
@@ -2658,7 +2650,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2658
2650
|
</ul>
|
|
2659
2651
|
|
|
2660
2652
|
|
|
2661
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2653
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-invalidate-api-key.html>`_
|
|
2662
2654
|
|
|
2663
2655
|
:param id:
|
|
2664
2656
|
:param ids: A list of API key ids. This parameter cannot be used with any of
|
|
@@ -2742,7 +2734,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2742
2734
|
If none of these two are specified, then <code>realm_name</code> and/or <code>username</code> need to be specified.</p>
|
|
2743
2735
|
|
|
2744
2736
|
|
|
2745
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2737
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-invalidate-token.html>`_
|
|
2746
2738
|
|
|
2747
2739
|
:param realm_name: The name of an authentication realm. This parameter cannot
|
|
2748
2740
|
be used with either `refresh_token` or `token`.
|
|
@@ -2810,7 +2802,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2810
2802
|
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
2803
|
|
|
2812
2804
|
|
|
2813
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2805
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-authenticate.html>`_
|
|
2814
2806
|
|
|
2815
2807
|
:param nonce: Associate a client session with an ID token and mitigate replay
|
|
2816
2808
|
attacks. This value needs to be the same as the one that was provided to
|
|
@@ -2890,7 +2882,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2890
2882
|
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
2883
|
|
|
2892
2884
|
|
|
2893
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2885
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-logout.html>`_
|
|
2894
2886
|
|
|
2895
2887
|
:param token: The access token to be invalidated.
|
|
2896
2888
|
:param refresh_token: The refresh token to be invalidated.
|
|
@@ -2952,7 +2944,7 @@ class SecurityClient(NamespacedClient):
|
|
|
2952
2944
|
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
2945
|
|
|
2954
2946
|
|
|
2955
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
2947
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-oidc-prepare-authentication.html>`_
|
|
2956
2948
|
|
|
2957
2949
|
:param iss: In the case of a third party initiated single sign on, this is the
|
|
2958
2950
|
issuer identifier for the OP that the RP is to send the authentication request
|
|
@@ -3048,7 +3040,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3048
3040
|
<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
3041
|
|
|
3050
3042
|
|
|
3051
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3043
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-privileges.html>`_
|
|
3052
3044
|
|
|
3053
3045
|
:param privileges:
|
|
3054
3046
|
:param refresh: If `true` (the default) then refresh the affected shards to make
|
|
@@ -3200,7 +3192,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3200
3192
|
File-based role management is not available in Elastic Serverless.</p>
|
|
3201
3193
|
|
|
3202
3194
|
|
|
3203
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3195
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role.html>`_
|
|
3204
3196
|
|
|
3205
3197
|
:param name: The name of the role.
|
|
3206
3198
|
:param applications: A list of application privilege entries.
|
|
@@ -3332,7 +3324,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3332
3324
|
If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names.</p>
|
|
3333
3325
|
|
|
3334
3326
|
|
|
3335
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3327
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-role-mapping.html>`_
|
|
3336
3328
|
|
|
3337
3329
|
:param name: The distinct name that identifies the role mapping. The name is
|
|
3338
3330
|
used solely as an identifier to facilitate interaction via the API; it does
|
|
@@ -3434,7 +3426,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3434
3426
|
To change a user's password without updating any other fields, use the change password API.</p>
|
|
3435
3427
|
|
|
3436
3428
|
|
|
3437
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3429
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-put-user.html>`_
|
|
3438
3430
|
|
|
3439
3431
|
:param username: An identifier for the user. NOTE: Usernames must be at least
|
|
3440
3432
|
1 and no more than 507 characters. They can contain alphanumeric characters
|
|
@@ -3553,7 +3545,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3553
3545
|
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
3546
|
|
|
3555
3547
|
|
|
3556
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3548
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-api-key.html>`_
|
|
3557
3549
|
|
|
3558
3550
|
:param aggregations: Any aggregations to run over the corpus of returned API
|
|
3559
3551
|
keys. Aggregations and queries work together. Aggregations are computed only
|
|
@@ -3696,7 +3688,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3696
3688
|
Also, the results can be paginated and sorted.</p>
|
|
3697
3689
|
|
|
3698
3690
|
|
|
3699
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3691
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-role.html>`_
|
|
3700
3692
|
|
|
3701
3693
|
:param from_: The starting document offset. It must not be negative. By default,
|
|
3702
3694
|
you cannot page through more than 10,000 hits using the `from` and `size`
|
|
@@ -3789,7 +3781,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3789
3781
|
This API is only for native users.</p>
|
|
3790
3782
|
|
|
3791
3783
|
|
|
3792
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3784
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-user.html>`_
|
|
3793
3785
|
|
|
3794
3786
|
:param from_: The starting document offset. It must not be negative. By default,
|
|
3795
3787
|
you cannot page through more than 10,000 hits using the `from` and `size`
|
|
@@ -3882,7 +3874,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3882
3874
|
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
3875
|
|
|
3884
3876
|
|
|
3885
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3877
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-authenticate.html>`_
|
|
3886
3878
|
|
|
3887
3879
|
:param content: The SAML response as it was sent by the user's browser, usually
|
|
3888
3880
|
a Base64 encoded XML document.
|
|
@@ -3955,7 +3947,7 @@ class SecurityClient(NamespacedClient):
|
|
|
3955
3947
|
The caller of this API must prepare the request accordingly so that this API can handle either of them.</p>
|
|
3956
3948
|
|
|
3957
3949
|
|
|
3958
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
3950
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-complete-logout.html>`_
|
|
3959
3951
|
|
|
3960
3952
|
:param ids: A JSON array with all the valid SAML Request Ids that the caller
|
|
3961
3953
|
of the API has for the current user.
|
|
@@ -4031,7 +4023,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4031
4023
|
Thus the user can be redirected back to their IdP.</p>
|
|
4032
4024
|
|
|
4033
4025
|
|
|
4034
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4026
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-invalidate.html>`_
|
|
4035
4027
|
|
|
4036
4028
|
:param query_string: The query part of the URL that the user was redirected to
|
|
4037
4029
|
by the SAML IdP to initiate the Single Logout. This query should include
|
|
@@ -4106,7 +4098,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4106
4098
|
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
4099
|
|
|
4108
4100
|
|
|
4109
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4101
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-logout.html>`_
|
|
4110
4102
|
|
|
4111
4103
|
:param token: The access token that was returned as a response to calling the
|
|
4112
4104
|
SAML authenticate API. Alternatively, the most recent token that was received
|
|
@@ -4176,7 +4168,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4176
4168
|
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
4169
|
|
|
4178
4170
|
|
|
4179
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4171
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-prepare-authentication.html>`_
|
|
4180
4172
|
|
|
4181
4173
|
:param acs: The Assertion Consumer Service URL that matches the one of the SAML
|
|
4182
4174
|
realms in Elasticsearch. The realm is used to generate the authentication
|
|
@@ -4237,7 +4229,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4237
4229
|
This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.</p>
|
|
4238
4230
|
|
|
4239
4231
|
|
|
4240
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4232
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-saml-sp-metadata.html>`_
|
|
4241
4233
|
|
|
4242
4234
|
:param realm_name: The name of the SAML realm in Elasticsearch.
|
|
4243
4235
|
"""
|
|
@@ -4290,7 +4282,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4290
4282
|
Elastic reserves the right to change or remove this feature in future releases without prior notice.</p>
|
|
4291
4283
|
|
|
4292
4284
|
|
|
4293
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4285
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-suggest-user-profile.html>`_
|
|
4294
4286
|
|
|
4295
4287
|
:param data: A comma-separated list of filters for the `data` field of the profile
|
|
4296
4288
|
document. To return all content use `data=*`. To return a subset of content,
|
|
@@ -4377,7 +4369,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4377
4369
|
This change can occur if the owner user's permissions have changed since the API key was created or last modified.</p>
|
|
4378
4370
|
|
|
4379
4371
|
|
|
4380
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4372
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-api-key.html>`_
|
|
4381
4373
|
|
|
4382
4374
|
:param id: The ID of the API key to update.
|
|
4383
4375
|
:param expiration: The expiration time for the API key. By default, API keys
|
|
@@ -4465,7 +4457,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4465
4457
|
<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
4458
|
|
|
4467
4459
|
|
|
4468
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4460
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-cross-cluster-api-key.html>`_
|
|
4469
4461
|
|
|
4470
4462
|
:param id: The ID of the cross-cluster API key to update.
|
|
4471
4463
|
:param access: The access to be granted to this API key. The access is composed
|
|
@@ -4544,7 +4536,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4544
4536
|
This API does not yet support configuring the settings for indices before they are in use.</p>
|
|
4545
4537
|
|
|
4546
4538
|
|
|
4547
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4539
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-settings.html>`_
|
|
4548
4540
|
|
|
4549
4541
|
:param master_timeout: The period to wait for a connection to the master node.
|
|
4550
4542
|
If no response is received before the timeout expires, the request fails
|
|
@@ -4629,7 +4621,7 @@ class SecurityClient(NamespacedClient):
|
|
|
4629
4621
|
The <code>update_profile_data</code> global privilege grants privileges for updating only the allowed namespaces.</p>
|
|
4630
4622
|
|
|
4631
4623
|
|
|
4632
|
-
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.
|
|
4624
|
+
`<https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-user-profile-data.html>`_
|
|
4633
4625
|
|
|
4634
4626
|
:param uid: A unique identifier for the user profile.
|
|
4635
4627
|
:param data: Non-searchable data that you want to associate with the user profile.
|