@elastic/schemas 0.4.5 → 0.5.1

package/src/es/json/searchable_snapshots.clear_cache.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).","x-found-in":"path"}},"description":"Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache","description":"Clear the cache.\n\nClear indices and data streams from the shared cache for partially mounted indices.","x-api":{"id":"searchable-snapshots.clear_cache","name":"clear-cache","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/{index}/_searchable_snapshots/cache/clear","x-urls":[{"path":"/_searchable_snapshots/cache/clear","methods":["POST"]},{"path":"/{index}/_searchable_snapshots/cache/clear","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"experimental"}},"type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams, indices, and aliases to clear from the cache.\nIt supports wildcards (`*`).","x-found-in":"path"}}}

package/src/es/json/searchable_snapshots.clear_cache.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.clear_cache","x-api":{"id":"searchable-snapshots.clear_cache","name":"clear-cache","namespace":"searchable-snapshots"}}

package/src/es/json/searchable_snapshots.mount.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until the operation is complete.","x-found-in":"query"},"storage":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption","description":"The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)","x-found-in":"query"},"index":{"type":"string","description":"The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.","x-found-in":"body"},"renamed_index":{"type":"string","description":"The name of the index that will be created.","x-found-in":"body"},"index_settings":{"type":"object","additionalProperties":{},"description":"The settings that should be added to the index when it is mounted.","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The names of settings that should be removed from the index when it is mounted.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository containing the snapshot of the index to mount.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot of the index to mount.","x-found-in":"path"}},"required":["repository","snapshot","index"],"description":"Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","description":"Mount a snapshot.\n\nMount a snapshot as a searchable snapshot index.\nDo not use this API for snapshots managed by index lifecycle management (ILM).\nManually mounting ILM-managed snapshots can interfere with ILM processes.","x-api":{"id":"searchable-snapshots.mount","name":"mount","namespace":"searchable-snapshots"},"x-method":"POST","x-path":"/_snapshot/{repository}/{snapshot}/_mount","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}/_mount","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If true, the request blocks until the operation is complete.","x-found-in":"query"},"storage":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__StorageOption","description":"The mount option for the searchable snapshot index.\nFor further information on mount options, refer to: [Mount options](https://www.elastic.co/docs/deploy-manage/tools/snapshot-and-restore/searchable-snapshots#searchable-snapshot-mount-storage-options)","x-found-in":"query"},"index":{"type":"string","description":"The name of the index contained in the snapshot whose data is to be mounted.\nIf no `renamed_index` is specified, this name will also be used to create the new index.","x-found-in":"body"},"renamed_index":{"type":"string","description":"The name of the index that will be created.","x-found-in":"body"},"index_settings":{"type":"object","additionalProperties":{},"description":"The settings that should be added to the index when it is mounted.","x-found-in":"body"},"ignore_index_settings":{"type":"array","items":{"type":"string"},"description":"The names of settings that should be removed from the index when it is mounted.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository containing the snapshot of the index to mount.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot of the index to mount.","x-found-in":"path"}},"required":["repository","snapshot","index"]}

package/src/es/json/searchable_snapshots.mount.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","type":"object","properties":{"snapshot":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__MountedSnapshot"}},"required":["snapshot"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.mount","x-api":{"id":"searchable-snapshots.mount","name":"mount","namespace":"searchable-snapshots"},"type":"object","properties":{"snapshot":{"$ref":"./searchable_snapshots.mount.json#/$defs/searchable_snapshots.mount__MountedSnapshot"}},"required":["snapshot"]}

package/src/es/json/searchable_snapshots.stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","type":"object","properties":{"level":{"$ref":"./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel","description":"Return stats aggregated at cluster, index or shard level","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to retrieve statistics for.","x-found-in":"path"}},"description":"Get searchable snapshot statistics."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","description":"Get searchable snapshot statistics.","x-api":{"id":"searchable-snapshots.stats","name":"stats","namespace":"searchable-snapshots"},"x-method":"GET","x-path":"/{index}/_searchable_snapshots/stats","x-urls":[{"path":"/_searchable_snapshots/stats","methods":["GET"]},{"path":"/{index}/_searchable_snapshots/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"}},"type":"object","properties":{"level":{"$ref":"./searchable_snapshots._types.json#/$defs/searchable_snapshots._types__StatsLevel","description":"Return stats aggregated at cluster, index or shard level","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to retrieve statistics for.","x-found-in":"path"}}}

package/src/es/json/searchable_snapshots.stats.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","type":"object","properties":{"stats":{},"total":{}},"required":["stats","total"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"searchable_snapshots.stats","x-api":{"id":"searchable-snapshots.stats","name":"stats","namespace":"searchable-snapshots"},"type":"object","properties":{"stats":{},"total":{}},"required":["stats","total"]}

package/src/es/json/security._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters."},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions."},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware."},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES|QL data sources."}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`)."},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds."},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions."},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access."},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys."},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists"},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]}},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters."},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions."},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware."},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security._types__GrantType":{"enum":["password","access_token"]},"security._types__UserProfileWithMetadata":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"},"last_synchronized":{"type":"number"},"_doc":{"$ref":"./security._types.json#/$defs/security._types__UserProfileHitMetadata"}},"required":["uid","user","data","labels","last_synchronized","_doc"]},"security._types__UserProfileUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"realm_name":{"type":"string"},"realm_domain":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"}},"required":["realm_name","roles","username"]},"security._types__UserProfileHitMetadata":{"type":"object","properties":{"_primary_term":{"type":"number"},"_seq_no":{"type":"number"}},"required":["_primary_term","_seq_no"]},"security._types__CredentialManagedBy":{"enum":["cloud","elasticsearch"]},"security._types__RealmInfo":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security._types__BulkError":{"type":"object","properties":{"count":{"type":"number","description":"The number of errors"},"details":{"type":"object","additionalProperties":{"$ref":"./_types.json#/$defs/_types__ErrorCause"},"description":"Details about the errors, keyed by role name"}},"required":["count","details"]},"security._types__RoleDescriptor":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}}},"security._types__ClusterPrivilege":{"anyOf":[{"enum":["all","cancel_task","create_snapshot","cross_cluster_replication","cross_cluster_search","delegate_pki","grant_api_key","manage","manage_api_key","manage_autoscaling","manage_behavioral_analytics","manage_ccr","manage_data_frame_transforms","manage_data_stream_global_retention","manage_enrich","manage_esql","manage_ilm","manage_index_templates","manage_inference","manage_ingest_pipelines","manage_logstash_pipelines","manage_ml","manage_oidc","manage_own_api_key","manage_pipeline","manage_reindex","manage_rollup","manage_saml","manage_search_application","manage_search_query_rules","manage_search_synonyms","manage_security","manage_service_account","manage_slm","manage_token","manage_transform","manage_user_profile","manage_watcher","monitor","monitor_data_frame_transforms","monitor_data_stream_global_retention","monitor_enrich","monitor_esql","monitor_inference","monitor_ml","monitor_reindex","monitor_rollup","monitor_snapshot","monitor_stats","monitor_text_structure","monitor_transform","monitor_watcher","none","post_behavioral_analytics_event","read_ccr","read_fleet_secrets","read_ilm","read_pipeline","read_security","read_slm","transport_client","write_connector_secrets","write_fleet_secrets","read_project_routing","manage_project_routing"]},{"type":"string"}]},"security._types__IndicesPrivileges":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names","privileges"]},"security._types__FieldSecurity":{"type":"object","properties":{"except":{"$ref":"./_types.json#/$defs/_types__Fields"},"grant":{"$ref":"./_types.json#/$defs/_types__Fields"}}},"security._types__IndexPrivilege":{"anyOf":[{"enum":["all","auto_configure","create","create_doc","create_index","create_view","cross_cluster_replication","cross_cluster_replication_internal","delete","delete_index","delete_view","index","maintenance","manage","manage_data_stream_lifecycle","manage_follow_index","manage_ilm","manage_leader_index","manage_view","monitor","none","read","read_cross_cluster","read_view_metadata","view_index_metadata","write"]},{"type":"string"}]},"security._types__IndicesPrivilegesQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"},{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateQuery"}],"description":"While creating or updating a role you can provide either a JSON structure or a string to the API.\nHowever, the response provided by Elasticsearch will only be string with a json-as-text content.\n\nSince this is embedded in `IndicesPrivileges`, the same structure is used for clarity in both contexts."},"security._types__RoleTemplateQuery":{"type":"object","properties":{"template":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateScript","description":"When you create a role, you can specify a query that defines the document level security permissions. You can optionally\nuse Mustache templates in the role query to insert the username of the current authenticated user into the role.\nLike other places in Elasticsearch that support templating or scripting, you can specify inline, stored, or file-based\ntemplates and define custom parameters. You access the details for the current authenticated user through the _user parameter."}}},"security._types__RoleTemplateScript":{"type":"object","properties":{"source":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplateInlineQuery"},"id":{"type":"string","description":"The `id` for a stored script."},"params":{"type":"object","additionalProperties":{},"description":"Specifies any named parameters that are passed into the script as variables.\nUse parameters instead of hard-coded values to decrease compile time."},"lang":{"$ref":"./_types.json#/$defs/_types__ScriptLanguage","description":"Specifies the language the script is written in."},"options":{"type":"object","additionalProperties":{"type":"string"}}}},"security._types__RoleTemplateInlineQuery":{"anyOf":[{"type":"string"},{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer"}]},"security._types__RemoteIndicesPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["clusters","names","privileges"],"description":"The subset of index level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivileges":{"type":"object","properties":{"clusters":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of cluster aliases to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivilege"},"description":"The cluster level privileges that owners of the role have on the remote cluster."}},"required":["clusters","privileges"],"description":"The subset of cluster level privileges that can be defined for remote clusters."},"security._types__RemoteClusterPrivilege":{"enum":["monitor_enrich","monitor_stats"]},"security._types__GlobalPrivilege":{"type":"object","properties":{"application":{"$ref":"./security._types.json#/$defs/security._types__ApplicationGlobalUserPrivileges"},"data_source":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivileges"},"description":"A list of data source privilege entries, used to grant access to ES|QL data sources.","x-availability":{"stack":{"since":"9.5.0"}}}},"required":["application"]},"security._types__ApplicationGlobalUserPrivileges":{"type":"object","properties":{"manage":{"$ref":"./security._types.json#/$defs/security._types__ManageUserPrivileges"}},"required":["manage"]},"security._types__ManageUserPrivileges":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"string"}}},"required":["applications"]},"security._types__DataSourcePrivileges":{"type":"object","properties":{"names":{"type":"array","items":{"type":"string"},"description":"A list of data source names or wildcard patterns to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__DataSourcePrivilege"},"description":"The data source privileges that owners of the role have for the specified data sources."}},"required":["names","privileges"]},"security._types__DataSourcePrivilege":{"anyOf":[{"enum":["create","delete","read_metadata","read","manage"]},{"type":"string"}]},"security._types__ApplicationPrivileges":{"type":"object","properties":{"application":{"type":"string","description":"The name of the application to which this entry applies."},"privileges":{"type":"array","items":{"type":"string"},"description":"A list of strings, where each element is the name of an application privilege or action."},"resources":{"type":"array","items":{"type":"string"},"description":"A list resources to which the privileges are applied."}},"required":["application","privileges","resources"]},"security._types__Restriction":{"type":"object","properties":{"workflows":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RestrictionWorkflow"},"description":"A list of workflows to which the API key is restricted.\nNOTE: In order to use a role restriction, an API key must be created with a single role descriptor."}},"required":["workflows"]},"security._types__RestrictionWorkflow":{"anyOf":[{"enum":["search_application_query"]},{"type":"string"}]},"security._types__ClusterNode":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"security._types__Access":{"type":"object","properties":{"replication":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ReplicationAccess"},"description":"A list of indices permission entries for cross-cluster replication."},"search":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__SearchAccess"},"description":"A list of indices permission entries for cross-cluster search."}}},"security._types__ReplicationAccess":{"type":"object","properties":{"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"allow_restricted_indices":{"type":"boolean","description":"This needs to be set to true if the patterns in the names field should cover system indices."}},"required":["names"]},"security._types__SearchAccess":{"type":"object","properties":{"field_security":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity","description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"query":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery","description":"A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`.","x-availability":{"stack":{}}}},"required":["names"]},"security._types__ApiKey":{"type":"object","properties":{"id":{"type":"string","description":"Id for the API key"},"name":{"type":"string","description":"Name of the API key."},"type":{"$ref":"./security._types.json#/$defs/security._types__ApiKeyType","description":"The type of the API key (e.g. `rest` or `cross_cluster`).","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"creation":{"description":"Creation time for the API key in milliseconds."},"expiration":{"description":"Expiration time for the API key in milliseconds."},"invalidated":{"type":"boolean","description":"Invalidation status for the API key.\nIf the key has been invalidated, it has a value of `true`. Otherwise, it is `false`."},"invalidation":{"description":"If the key has been invalidated, invalidation time in milliseconds.","x-availability":{"stack":{"since":"8.12.0"},"serverless":{}}},"username":{"type":"string","description":"Principal for which this API key was created"},"realm":{"type":"string","description":"Realm name of the principal for which this API key was created."},"realm_type":{"type":"string","description":"Realm type of the principal for which this API key was created","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Metadata of the API key","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors assigned to this API key when it was created or last updated.\nAn empty role descriptor means the API key inherits the owner user’s permissions."},"limited_by":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},"description":"The owner user’s permissions associated with the API key.\nIt is a point-in-time snapshot captured at creation and subsequent updates.\nAn API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.","x-availability":{"stack":{"since":"8.5.0"},"serverless":{}}},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access granted to cross-cluster API keys.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-availability":{"stack":{"since":"8.10.0"},"serverless":{}}},"certificate_identity":{"type":"string","description":"The certificate identity associated with a cross-cluster API key.\nRestricts the API key to connections authenticated by a specific TLS certificate.\nOnly applicable to cross-cluster API keys.","x-availability":{"stack":{"since":"9.3.0"}}},"profile_uid":{"type":"string","description":"The profile uid for the API key owner principal, if requested and if it exists","x-availability":{"stack":{"since":"8.14.0"},"serverless":{}}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"Sorting values when using the `sort` parameter with the `security.query_api_keys` API."}},"required":["id","name","type","creation","invalidated","username","realm","metadata"]},"security._types__ApiKeyType":{"enum":["rest","cross_cluster"]},"security._types__RoleTemplate":{"type":"object","properties":{"format":{"$ref":"./security._types.json#/$defs/security._types__TemplateFormat"},"template":{"$ref":"./_types.json#/$defs/_types__Script"}},"required":["template"]},"security._types__TemplateFormat":{"enum":["string","json"]},"security._types__RoleMapping":{"type":"object","properties":{"enabled":{"type":"boolean"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"required":["enabled","metadata","rules"]},"security._types__RoleMappingRule":{"type":"object","properties":{"any":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"all":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}},"field":{"type":"object","additionalProperties":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__FieldValue"},{"type":"array","items":{"$ref":"./_types.json#/$defs/_types__FieldValue"}}]}},"except":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule"}}},"security._types__RoleDescriptorRead":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters.","x-availability":{"stack":{"since":"8.14.0"}}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions.","x-availability":{"stack":{"since":"8.15.0"}}},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware.","x-availability":{"stack":{}}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}}},"required":["cluster","indices"]},"security._types__SecuritySettings":{"type":"object","properties":{"index":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"}}},"security._types__NodeSecurityStats":{"type":"object","properties":{"roles":{"$ref":"./security._types.json#/$defs/security._types__RolesStats","description":"Role statistics."}},"required":["roles"]},"security._types__RolesStats":{"type":"object","properties":{"dls":{"$ref":"./xpack.usage.json#/$defs/xpack.usage__SecurityRolesDls","description":"Document-level security (DLS) statistics."}},"required":["dls"]},"security._types__User":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"}},"required":["metadata","roles","username","enabled"]},"security._types__UserIndicesPrivileges":{"type":"object","properties":{"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["names","privileges","allow_restricted_indices"]},"security._types__RemoteUserIndicesPrivileges":{"type":"object","properties":{"clusters":{"type":"array","items":{"type":"string"}},"field_security":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__FieldSecurity"},"description":"The document fields that the owners of the role have read access to."},"names":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A list of indices (or index name patterns) to which the permissions in this entry apply."},"privileges":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndexPrivilege"},"description":"The index level privileges that owners of the role have on the specified indices."},"query":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivilegesQuery"},"description":"Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role."},"allow_restricted_indices":{"type":"boolean","description":"Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`."}},"required":["clusters","names","privileges","allow_restricted_indices"]},"security._types__CreatedStatus":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"]},"security._types__UserProfile":{"type":"object","properties":{"uid":{"type":"string"},"user":{"$ref":"./security._types.json#/$defs/security._types__UserProfileUser"},"data":{"type":"object","additionalProperties":{}},"labels":{"type":"object","additionalProperties":{}},"enabled":{"type":"boolean"}},"required":["uid","user","data","labels"]}}}

package/src/es/json/security.activate_user_profile.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","type":"object","properties":{"access_token":{"type":"string","description":"The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"grant_type":{"$ref":"./security._types.json#/$defs/security._types__GrantType","description":"The type of grant.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"username":{"type":"string","description":"The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"}},"required":["grant_type"],"description":"Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","description":"Activate a user profile.\n\nCreate or update a user profile on behalf of another user.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nThe calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nThis API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm.\nFor example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token.\n\nWhen updating a profile document, the API enables the document if it was disabled.\nAny updates do not change existing content for either the `labels` or `data` fields.","x-api":{"id":"security.activate_user_profile","name":"activate-user-profile","namespace":"security"},"x-method":"POST","x-path":"/_security/profile/_activate","x-urls":[{"path":"/_security/profile/_activate","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"access_token":{"type":"string","description":"The user's Elasticsearch access token or JWT.\nBoth `access` and `id` JWT token types are supported and they depend on the underlying JWT realm configuration.\nIf you specify the `access_token` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"grant_type":{"$ref":"./security._types.json#/$defs/security._types__GrantType","description":"The type of grant.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"},"username":{"type":"string","description":"The username that identifies the user.\nIf you specify the `password` grant type, this parameter is required.\nIt is not valid with other grant types.","x-found-in":"body"}},"required":["grant_type"]}

package/src/es/json/security.activate_user_profile.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","$ref":"./security._types.json#/$defs/security._types__UserProfileWithMetadata"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.activate_user_profile","x-api":{"id":"security.activate_user_profile","name":"activate-user-profile","namespace":"security"},"$ref":"./security._types.json#/$defs/security._types__UserProfileWithMetadata"}

package/src/es/json/security.authenticate.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.authenticate__AuthenticateApiKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"managed_by":{"$ref":"./security._types.json#/$defs/security._types__CredentialManagedBy"},"internal":{"type":"boolean"}},"required":["id","managed_by"]},"security.authenticate__Token":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"managed_by":{"$ref":"./security._types.json#/$defs/security._types__CredentialManagedBy"}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.authenticate__AuthenticateApiKey":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"managed_by":{"$ref":"./security._types.json#/$defs/security._types__CredentialManagedBy"},"internal":{"type":"boolean"}},"required":["id","managed_by"]},"security.authenticate__Token":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"managed_by":{"$ref":"./security._types.json#/$defs/security._types__CredentialManagedBy","x-availability":{"stack":{"since":"9.4.0"},"serverless":{}}}}}}}

package/src/es/json/security.authenticate.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","type":"object","properties":{},"description":"Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","description":"Authenticate a user.\n\nAuthenticates a user and returns information about the authenticated user.\nInclude the user information in a [basic auth header](https://en.wikipedia.org/wiki/Basic_access_authentication).\nA successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user.\nIf the user cannot be authenticated, this API returns a 401 status code.","x-api":{"id":"security.authenticate","name":"authenticate","namespace":"security"},"x-method":"GET","x-path":"/_security/_authenticate","x-urls":[{"path":"/_security/_authenticate","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"5.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{}}

package/src/es/json/security.authenticate.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","type":"object","properties":{"api_key":{"$ref":"./security.authenticate.json#/$defs/security.authenticate__AuthenticateApiKey"},"authentication_realm":{"$ref":"./security._types.json#/$defs/security._types__RealmInfo"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lookup_realm":{"$ref":"./security._types.json#/$defs/security._types__RealmInfo"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"authentication_type":{"type":"string"},"token":{"$ref":"./security.authenticate.json#/$defs/security.authenticate__Token"}},"required":["authentication_realm","lookup_realm","metadata","roles","username","enabled","authentication_type"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.authenticate","x-api":{"id":"security.authenticate","name":"authenticate","namespace":"security"},"type":"object","properties":{"api_key":{"$ref":"./security.authenticate.json#/$defs/security.authenticate__AuthenticateApiKey"},"authentication_realm":{"$ref":"./security._types.json#/$defs/security._types__RealmInfo"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"lookup_realm":{"$ref":"./security._types.json#/$defs/security._types__RealmInfo"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"authentication_type":{"type":"string"},"token":{"$ref":"./security.authenticate.json#/$defs/security.authenticate__Token","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}}},"required":["authentication_realm","lookup_realm","metadata","roles","username","enabled","authentication_type"]}

package/src/es/json/security.bulk_delete_role.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"names":{"type":"array","items":{"type":"string"},"description":"An array of role names to delete","x-found-in":"body"}},"required":["names"],"description":"Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","description":"Bulk delete roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk delete roles API cannot delete roles that are defined in roles files.","x-api":{"id":"security.bulk_delete_role","name":"bulk-delete-role","namespace":"security"},"x-method":"DELETE","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"names":{"type":"array","items":{"type":"string"},"description":"An array of role names to delete","x-found-in":"body"}},"required":["names"]}

package/src/es/json/security.bulk_delete_role.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"Array of deleted roles"},"not_found":{"type":"array","items":{"type":"string"},"description":"Array of roles that could not be found"},"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError","description":"Present if any deletes resulted in errors"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_delete_role","x-api":{"id":"security.bulk_delete_role","name":"bulk-delete-role","namespace":"security"},"type":"object","properties":{"deleted":{"type":"array","items":{"type":"string"},"description":"Array of deleted roles"},"not_found":{"type":"array","items":{"type":"string"},"description":"Array of roles that could not be found"},"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError","description":"Present if any deletes resulted in errors"}}}

package/src/es/json/security.bulk_put_role.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"roles":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"A dictionary of role name to RoleDescriptor objects to add or update","x-found-in":"body"}},"required":["roles"],"description":"Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","description":"Bulk create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe bulk create or update roles API cannot update roles that are defined in roles files.","x-api":{"id":"security.bulk_put_role","name":"bulk-put-role","namespace":"security"},"x-method":"POST","x-path":"/_security/role","x-urls":[{"path":"/_security/role","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.15.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"roles":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"A dictionary of role name to RoleDescriptor objects to add or update","x-found-in":"body"}},"required":["roles"]}

package/src/es/json/security.bulk_put_role.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","type":"object","properties":{"created":{"type":"array","items":{"type":"string"},"description":"Array of created roles"},"updated":{"type":"array","items":{"type":"string"},"description":"Array of updated roles"},"noop":{"type":"array","items":{"type":"string"},"description":"Array of role names without any changes"},"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError","description":"Present if any updates resulted in errors"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_put_role","x-api":{"id":"security.bulk_put_role","name":"bulk-put-role","namespace":"security"},"type":"object","properties":{"created":{"type":"array","items":{"type":"string"},"description":"Array of created roles"},"updated":{"type":"array","items":{"type":"string"},"description":"Array of updated roles"},"noop":{"type":"array","items":{"type":"string"},"description":"Array of role names without any changes"},"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError","description":"Present if any updates resulted in errors"}}}

package/src/es/json/security.bulk_update_api_keys.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","type":"object","properties":{"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.","x-found-in":"body"},"ids":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The API key identifiers.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"}},"required":["ids"],"description":"Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA 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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","description":"Bulk update API keys.\n\nUpdate the attributes for multiple API keys.\n\nIMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required.\n\nThis API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates.\n\nIt is not possible to update expired or invalidated API keys.\n\nThis API supports updates to API key access scope, metadata and expiration.\nThe access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified.\n\nA 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.","x-api":{"id":"security.bulk_update_api_keys","name":"bulk-update-api-keys","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/_bulk_update","x-urls":[{"path":"/_security/api_key/_bulk_update","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.5.0","stability":"stable","visibility":"public"}},"type":"object","properties":{"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API keys.\nBy default, API keys never expire.\nThis property can be omitted to leave the value unchanged.","x-found-in":"body"},"ids":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"The API key identifiers.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary nested metadata to associate with the API keys.\nWithin the `metadata` object, top-level keys beginning with an underscore (`_`) are reserved for system usage.\nAny information specified with this parameter fully replaces metadata previously associated with the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to the API keys.\nAn API key's effective permissions are an intersection of its assigned privileges and the point-in-time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, supply the `role_descriptors` parameter as an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"}},"required":["ids"]}

package/src/es/json/security.bulk_update_api_keys.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","type":"object","properties":{"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError"},"noops":{"type":"array","items":{"type":"string"}},"updated":{"type":"array","items":{"type":"string"}}},"required":["noops","updated"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.bulk_update_api_keys","x-api":{"id":"security.bulk_update_api_keys","name":"bulk-update-api-keys","namespace":"security"},"type":"object","properties":{"errors":{"$ref":"./security._types.json#/$defs/security._types__BulkError"},"noops":{"type":"array","items":{"type":"string"}},"updated":{"type":"array","items":{"type":"string"}}},"required":["noops","updated"]}

package/src/es/json/security.change_password.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"password":{"type":"string","description":"The new password value. Passwords must be at least 6 characters long.","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.","x-found-in":"body"},"username":{"type":"string","description":"The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.","x-found-in":"path"}},"description":"Change passwords.\n\nChange the passwords of users in the native realm and built-in users."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","description":"Change passwords.\n\nChange the passwords of users in the native realm and built-in users.","x-api":{"id":"security.change_password","name":"change-password","namespace":"security"},"x-method":"PUT","x-path":"/_security/user/{username}/_password","x-urls":[{"path":"/_security/user/{username}/_password","methods":["PUT","POST"]},{"path":"/_security/user/_password","methods":["PUT","POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"password":{"type":"string","description":"The new password value. Passwords must be at least 6 characters long.","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the new password value. This must be produced using the same\nhashing algorithm as has been configured for password storage. For more details,\nsee the explanation of the `xpack.security.authc.password_hashing.algorithm`\nsetting.","x-found-in":"body"},"username":{"type":"string","description":"The user whose password you want to change. If you do not specify this\nparameter, the password is changed for the current user.","x-found-in":"path"}}}

package/src/es/json/security.change_password.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","type":"object","properties":{}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.change_password","x-api":{"id":"security.change_password","name":"change-password","namespace":"security"},"type":"object","properties":{}}

package/src/es/json/security.clear_api_key_cache.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","type":"object","properties":{"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.","x-found-in":"path"}},"required":["ids"],"description":"Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","description":"Clear the API key cache.\n\nEvict a subset of all entries from the API key cache.\nThe cache is also automatically cleared on state changes of the security index.","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/{ids}/_clear_cache","x-urls":[{"path":"/_security/api_key/{ids}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"ids":{"$ref":"./_types.json#/$defs/_types__Ids","description":"Comma-separated list of API key IDs to evict from the API key cache.\nTo evict all API keys, use `*`.\nDoes not support other wildcard patterns.","x-found-in":"path"}},"required":["ids"]}

package/src/es/json/security.clear_api_key_cache.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_api_key_cache","x-api":{"id":"security.clear_api_key_cache","name":"clear-api-key-cache","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_privileges.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","type":"object","properties":{"application":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["application"],"description":"Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","description":"Clear the privileges cache.\n\nEvict privileges from the native application privilege cache.\nThe cache is also automatically cleared for applications that have their privileges updated.","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"x-method":"POST","x-path":"/_security/privilege/{application}/_clear_cache","x-urls":[{"path":"/_security/privilege/{application}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.9.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"application":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of applications.\nTo clear all applications, use an asterism (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["application"]}

package/src/es/json/security.clear_cached_privileges.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_privileges","x-api":{"id":"security.clear_cached_privileges","name":"clear-cached-privileges","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_realms.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.","x-found-in":"query"},"realms":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["realms"],"description":"Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","description":"Clear the user cache.\n\nEvict users from the user cache.\nYou can completely clear the cache or evict specific users.\n\nUser credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request.\nThere are realm settings that you can use to configure the user cache.\nFor more information, refer to the documentation about controlling the user cache.","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"x-method":"POST","x-path":"/_security/realm/{realms}/_clear_cache","x-urls":[{"path":"/_security/realm/{realms}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"usernames":{"type":"array","items":{"type":"string"},"description":"A comma-separated list of the users to clear from the cache.\nIf you do not specify this parameter, the API evicts all users from the user cache.","x-found-in":"query"},"realms":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of realms.\nTo clear all realms, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["realms"]}

package/src/es/json/security.clear_cached_realms.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_realms","x-api":{"id":"security.clear_cached_realms","name":"clear-cached-realms","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_roles.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_roles","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["name"],"description":"Clear the roles cache.\n\nEvict roles from the native role cache."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_roles","description":"Clear the roles cache.\n\nEvict roles from the native role cache.","x-api":{"id":"security.clear_cached_roles","name":"clear-cached-roles","namespace":"security"},"x-method":"POST","x-path":"/_security/role/{name}/_clear_cache","x-urls":[{"path":"/_security/role/{name}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of roles to evict from the role cache.\nTo evict all roles, use an asterisk (`*`).\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["name"]}

package/src/es/json/security.clear_cached_roles.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_roles","type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_roles","x-api":{"id":"security.clear_cached_roles","name":"clear-cached-roles","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}

package/src/es/json/security.clear_cached_service_tokens.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_service_tokens","type":"object","properties":{"namespace":{"type":"string","description":"The namespace, which is a top-level grouping of service accounts.","x-found-in":"path"},"service":{"type":"string","description":"The name of the service, which must be unique within its namespace.","x-found-in":"path"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["namespace","service","name"],"description":"Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_service_tokens","description":"Clear service account token caches.\n\nEvict a subset of all entries from the service account token caches.\nTwo separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index.\nThis API clears matching entries from both caches.\n\nThe cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index.\nThe cache for tokens backed by the `service_tokens` file is cleared automatically on file changes.","x-api":{"id":"security.clear_cached_service_tokens","name":"clear-cached-service-tokens","namespace":"security"},"x-method":"POST","x-path":"/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache","x-urls":[{"path":"/_security/service/{namespace}/{service}/credential/token/{name}/_clear_cache","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"namespace":{"type":"string","description":"The namespace, which is a top-level grouping of service accounts.","x-found-in":"path"},"service":{"type":"string","description":"The name of the service, which must be unique within its namespace.","x-found-in":"path"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of token names to evict from the service account token caches.\nUse a wildcard (`*`) to evict all tokens that belong to a service account.\nIt does not support other wildcard patterns.","x-found-in":"path"}},"required":["namespace","service","name"]}

package/src/es/json/security.clear_cached_service_tokens.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_service_tokens","type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clear_cached_service_tokens","x-api":{"id":"security.clear_cached_service_tokens","name":"clear-cached-service-tokens","namespace":"security"},"type":"object","properties":{"node_stats":{"$ref":"./_types.json#/$defs/_types__NodeStatistics"},"cluster_name":{"type":"string"},"nodes":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__ClusterNode"}}},"required":["node_stats","cluster_name","nodes"]}

package/src/es/json/security.clone_api_key.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clone_api_key","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"api_key":{"type":"string","description":"The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.","x-found-in":"body"},"name":{"type":"string","description":"A name for the cloned API key.\nIf not provided, the name of the source key is used.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"}},"required":["api_key"],"description":"Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clone_api_key","description":"Clone an API key.\n\nCreate a copy of an existing API key with a new ID.\nThe cloned key inherits the role descriptors of the source key.\nThis is intended for applications (such as Kibana) that need to\ncreate API keys on behalf of a user using an existing API key credential,\nsince derived API keys (API keys created by API keys) are not otherwise supported.","x-api":{"id":"security.clone_api_key","name":"clone-api-key","namespace":"security"},"x-method":"POST","x-path":"/_security/api_key/clone","x-urls":[{"path":"/_security/api_key/clone","methods":["POST","PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"9.4.0","stability":"experimental"},"serverless":{"stability":"experimental","visibility":"private"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"api_key":{"type":"string","description":"The credentials of the API key to clone.\nThis is the secret value returned when the key was originally created.","x-found-in":"body"},"name":{"type":"string","description":"A name for the cloned API key.\nIf not provided, the name of the source key is used.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the cloned API key.\nBy default, API keys never expire.\nSet to `null` to explicitly create a key with no expiration.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata to associate with the cloned API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"}},"required":["api_key"]}

package/src/es/json/security.clone_api_key.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clone_api_key","type":"object","properties":{"api_key":{"type":"string","description":"The generated API key value for the cloned key."},"expiration":{"type":"number","description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"The unique ID of the cloned API key."},"name":{"type":"string","description":"The name of the cloned API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`)."}},"required":["api_key","id","name","encoded"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.clone_api_key","x-api":{"id":"security.clone_api_key","name":"clone-api-key","namespace":"security"},"type":"object","properties":{"api_key":{"type":"string","description":"The generated API key value for the cloned key."},"expiration":{"type":"number","description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"The unique ID of the cloned API key."},"name":{"type":"string","description":"The name of the cloned API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`)."}},"required":["api_key","id","name","encoded"]}

package/src/es/json/security.create_api_key.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_api_key","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire.","x-found-in":"body"},"name":{"type":"string","description":"A name for the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"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.","x-found-in":"body"}},"description":"Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_api_key","description":"Create an API key.\n\nCreate an API key for access without requiring basic authentication.\n\nIMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges.\nIf you specify privileges, the API returns an error.\n\nA successful request returns a JSON structure that contains the API key, its unique id, and its name.\nIf applicable, it also returns expiration information for the API key in milliseconds.\n\nNOTE: By default, API keys never expire. You can specify expiration information when you create the API keys.\n\nThe API keys are created by the Elasticsearch API key service, which is automatically enabled.\nTo configure or turn off the API key service, refer to API key service setting documentation.","x-api":{"id":"security.create_api_key","name":"create-api-key","namespace":"security"},"x-method":"PUT","x-path":"/_security/api_key","x-urls":[{"path":"/_security/api_key","methods":["PUT","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"6.7.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire.","x-found-in":"body"},"name":{"type":"string","description":"A name for the API key.","x-found-in":"body"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"An array of role descriptors for this API key.\nWhen it is not specified or it is an empty array, the API key will have a point in time snapshot of permissions of the authenticated user.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the authenticated user's permissions thereby limiting the access scope for API keys.\nThe structure of role descriptor is the same as the request for the create role API.\nFor more details, refer to the create or update roles API.\n\nNOTE: Due to the way in which this permission intersection is calculated, it is not possible to create an API key that is a child of another API key, unless the derived key is created without any privileges.\nIn this case, you must explicitly specify a role descriptor with no privileges.\nThe derived API key can be used for authentication; it will not have authority to call Elasticsearch APIs.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"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.","x-found-in":"body","x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}}}}

package/src/es/json/security.create_api_key.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_api_key","type":"object","properties":{"api_key":{"type":"string","description":"Generated API key."},"expiration":{"type":"number","description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"Unique ID for this API key."},"name":{"type":"string","description":"Specifies the name for this API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`)."}},"required":["api_key","id","name","encoded"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_api_key","x-api":{"id":"security.create_api_key","name":"create-api-key","namespace":"security"},"type":"object","properties":{"api_key":{"type":"string","description":"Generated API key."},"expiration":{"type":"number","description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"Unique ID for this API key."},"name":{"type":"string","description":"Specifies the name for this API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`).","x-availability":{"stack":{"since":"7.16.0"},"serverless":{}}}},"required":["api_key","id","name","encoded"]}

package/src/es/json/security.create_cross_cluster_api_key.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_cross_cluster_api_key","type":"object","properties":{"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API key.\nBy default, API keys never expire.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"},"name":{"type":"string","description":"Specifies the name for this API key.","x-found-in":"body"},"certificate_identity":{"type":"string","description":"The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.","x-found-in":"body"}},"required":["access","name"],"description":"Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_cross_cluster_api_key","description":"Create a cross-cluster API key.\n\nCreate an API key of the `cross_cluster` type for the API key based remote cluster access.\nA `cross_cluster` API key cannot be used to authenticate through the REST interface.\n\nIMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error.\n\nCross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled.\n\nNOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property.\n\nA successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds.\n\nBy default, API keys never expire. You can specify expiration information when you create the API keys.\n\nCross-cluster API keys can only be updated with the update cross-cluster API key API.\nAttempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.","x-api":{"id":"security.create_cross_cluster_api_key","name":"create-cross-cluster-api-key","namespace":"security"},"x-method":"POST","x-path":"/_security/cross_cluster/api_key","x-urls":[{"path":"/_security/cross_cluster/api_key","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"}},"type":"object","properties":{"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access to be granted to this API key.\nThe access is composed of permissions for cross-cluster search and cross-cluster replication.\nAt least one of them must be specified.\n\nNOTE: No explicit privileges should be specified for either search or replication access.\nThe creation process automatically converts the access specification to a role descriptor which has relevant privileges assigned accordingly.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Expiration time for the API key.\nBy default, API keys never expire.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"},"name":{"type":"string","description":"Specifies the name for this API key.","x-found-in":"body"},"certificate_identity":{"type":"string","description":"The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.","x-found-in":"body"}},"required":["access","name"]}

package/src/es/json/security.create_cross_cluster_api_key.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_cross_cluster_api_key","type":"object","properties":{"api_key":{"type":"string","description":"Generated API key."},"expiration":{"description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"Unique ID for this API key."},"name":{"type":"string","description":"Specifies the name for this API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`)."}},"required":["api_key","id","name","encoded"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_cross_cluster_api_key","x-api":{"id":"security.create_cross_cluster_api_key","name":"create-cross-cluster-api-key","namespace":"security"},"type":"object","properties":{"api_key":{"type":"string","description":"Generated API key."},"expiration":{"description":"Expiration in milliseconds for the API key."},"id":{"type":"string","description":"Unique ID for this API key."},"name":{"type":"string","description":"Specifies the name for this API key."},"encoded":{"type":"string","description":"API key credentials which is the base64-encoding of\nthe UTF-8 representation of `id` and `api_key` joined\nby a colon (`:`)."}},"required":["api_key","id","name","encoded"]}

package/src/es/json/security.create_service_token.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_service_token","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"namespace":{"type":"string","description":"The name of the namespace, which is a top-level grouping of service accounts.","x-found-in":"path"},"service":{"type":"string","description":"The name of the service.","x-found-in":"path"},"name":{"type":"string","description":"The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.","x-found-in":"path"}},"required":["namespace","service"],"description":"Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.\n\nIMPORTANT: On Serverless, non-operator users can create tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nCreating tokens for any other service account requires operator privileges."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.create_service_token","description":"Create a service account token.\n\nCreate a service accounts token for access without requiring basic authentication.\n\nNOTE: Service account tokens never expire.\nYou must actively delete them if they are no longer needed.\n\nIMPORTANT: On Serverless, non-operator users can create tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nCreating tokens for any other service account requires operator privileges.","x-api":{"id":"security.create_service_token","name":"create-service-token","namespace":"security"},"x-method":"PUT","x-path":"/_security/service/{namespace}/{service}/credential/token/{name}","x-urls":[{"path":"/_security/service/{namespace}/{service}/credential/token/{name}","methods":["PUT","POST"]},{"path":"/_security/service/{namespace}/{service}/credential/token","methods":["POST"]}],"x-destructive":false,"x-availability":{"stack":{"stability":"stable"},"serverless":{"stability":"stable","visibility":"public"}},"type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"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.","x-found-in":"query"},"namespace":{"type":"string","description":"The name of the namespace, which is a top-level grouping of service accounts.","x-found-in":"path"},"service":{"type":"string","description":"The name of the service.","x-found-in":"path"},"name":{"type":"string","description":"The name for the service account token.\nIf omitted, a random name will be generated.\n\nToken names must be at least one and no more than 256 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.\n\nNOTE: Token names must be unique in the context of the associated service account.\nThey must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `<namespace>/<service>/<token-name>`.","x-found-in":"path"}},"required":["namespace","service"]}