You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
** *`script` (Optional, { lang, options, source } | { id })*: The script to run to update the document source or metadata when updating.
1301
+
** *`script` (Optional, { source, id, params, lang, options })*: The script to run to update the document source or metadata when updating.
1302
1302
** *`slice` (Optional, { field, id, max })*: Slice the request manually using the provided slice ID and total number of slices.
1303
1303
** *`conflicts` (Optional, Enum("abort" | "proceed"))*: What to do if update by query hits version conflicts: `abort` or `proceed`.
1304
1304
** *`allow_no_indices` (Optional, boolean)*: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
** *`names` (string[])*: An array of role names to delete
8239
+
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
8240
+
8241
+
[discrete]
8242
+
==== bulk_put_role
8243
+
The role management APIs are generally the preferred way to manage roles, rather than using file-based role management.
8244
+
The bulk create or update roles API cannot update roles that are defined in roles files.
** *`roles` (Record<string, { cluster, indices, global, applications, metadata, run_as, description, transient_metadata }>)*: A dictionary of role name to RoleDescriptor objects to add or update
8257
+
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
8258
+
8196
8259
[discrete]
8197
8260
==== bulk_update_api_keys
8198
8261
Updates the attributes of multiple existing API keys.
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. By default, API keys never expire.
8334
8397
** *`name` (Optional, string)*: Specifies the name for this API key.
8335
-
** *`role_descriptors` (Optional, Record<string, { cluster, indices, global, applications, metadata, run_as, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
8398
+
** *`role_descriptors` (Optional, Record<string, { cluster, indices, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
8336
8399
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.
8337
8400
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
8338
8401
@@ -8961,6 +9024,7 @@ client.security.putRole({ name })
8961
9024
** *`indices` (Optional, { field_security, names, privileges, query, allow_restricted_indices }[])*: A list of indices permissions entries.
8962
9025
** *`metadata` (Optional, Record<string, User-defined value>)*: Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.
8963
9026
** *`run_as` (Optional, string[])*: A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.
9027
+
** *`description` (Optional, string)*: Optional description of the role descriptor
8964
9028
** *`transient_metadata` (Optional, Record<string, User-defined value>)*: Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.
8965
9029
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes.
8966
9030
@@ -9050,16 +9114,65 @@ An API key's actual permission is the intersection of its assigned role descript
9050
9114
** *`with_profile_uid` (Optional, boolean)*: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists.
9051
9115
** *`typed_keys` (Optional, boolean)*: Determines whether aggregation names are prefixed by their respective types in the response.
9052
9116
9117
+
[discrete]
9118
+
==== query_role
9119
+
Retrieves roles in a paginated manner. You can optionally filter the results with a query.
By default, you cannot page through more than 10,000 hits using the from and size parameters.
9139
+
To page through more hits, use the `search_after` parameter.
9140
+
** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])*: All public fields of a role are eligible for sorting.
9141
+
In addition, sort can also be applied to the `_doc` field to sort by index order.
9142
+
** *`size` (Optional, number)*: The number of hits to return.
9143
+
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
9144
+
To page through more hits, use the `search_after` parameter.
9145
+
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition
9146
+
9053
9147
[discrete]
9054
9148
==== query_user
9055
-
Retrieves information for Users using a subset of query DSL
9149
+
Retrieves information for Users in a paginated manner. You can optionally filter the results with a query.
In addition, sort can also be applied to the `_doc` field to sort by index order.
9171
+
** *`size` (Optional, number)*: The number of hits to return.
9172
+
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
9173
+
To page through more hits, use the `search_after` parameter.
9174
+
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Search after definition
9175
+
** *`with_profile_uid` (Optional, boolean)*: If true will return the User Profile ID for the users in the query result, if any.
9063
9176
9064
9177
[discrete]
9065
9178
==== saml_authenticate
@@ -9229,7 +9342,7 @@ client.security.updateApiKey({ id })
9229
9342
9230
9343
* *Request (object):*
9231
9344
** *`id` (string)*: The ID of the API key to update.
9232
-
** *`role_descriptors` (Optional, Record<string, { cluster, indices, global, applications, metadata, run_as, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
9345
+
** *`role_descriptors` (Optional, Record<string, { cluster, indices, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
9233
9346
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.
9234
9347
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key.
9235
9348
@@ -10167,8 +10280,6 @@ index will not be deleted
10167
10280
[discrete]
10168
10281
==== get_node_stats
10169
10282
Retrieves transform usage information for transform nodes.
0 commit comments