@elastic/schemas 0.4.3 → 0.4.5

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":{"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"},"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"}},"description":"Get searchable snapshot statistics."}
+{"$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."}

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":{"oneOf":[{"type":"string"},{"type":"null"}]},"full_name":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"$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":{"oneOf":[{"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":{"oneOf":[{"type":"string"},{"type":"null"}]},"full_name":{"oneOf":[{"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":{"oneOf":[{"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":{"oneOf":[{"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."},"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"]}}}

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":{"oneOf":[{"type":"string"},{"type":"null"}]},"full_name":{"oneOf":[{"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","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"]}

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":{"oneOf":[{"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","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."}

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":{"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"},"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"}},"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","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."}

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":{"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"},"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"}},"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","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."}

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":{"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"},"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"}},"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","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."}

package/src/es/json/security.delegate_pki.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.delegate_pki__Authentication":{"type":"object","properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"full_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"email":{"oneOf":[{"type":"string"},{"type":"null"}]},"token":{"type":"object","additionalProperties":{"type":"string"}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"enabled":{"type":"boolean"},"authentication_realm":{"$ref":"./security.delegate_pki.json#/$defs/security.delegate_pki__AuthenticationRealm"},"lookup_realm":{"$ref":"./security.delegate_pki.json#/$defs/security.delegate_pki__AuthenticationRealm"},"authentication_type":{"type":"string"},"api_key":{"type":"object","additionalProperties":{"type":"string"}}},"required":["username","roles","full_name","email","metadata","enabled","authentication_realm","lookup_realm","authentication_type"]},"security.delegate_pki__AuthenticationRealm":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"domain":{"type":"string"}},"required":["name","type"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.delegate_pki__Authentication":{"type":"object","properties":{"username":{"type":"string"},"roles":{"type":"array","items":{"type":"string"}},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"token":{"type":"object","additionalProperties":{"type":"string"}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"enabled":{"type":"boolean"},"authentication_realm":{"$ref":"./security.delegate_pki.json#/$defs/security.delegate_pki__AuthenticationRealm"},"lookup_realm":{"$ref":"./security.delegate_pki.json#/$defs/security.delegate_pki__AuthenticationRealm"},"authentication_type":{"type":"string"},"api_key":{"type":"object","additionalProperties":{"type":"string"}}},"required":["username","roles","full_name","email","metadata","enabled","authentication_realm","lookup_realm","authentication_type"]},"security.delegate_pki__AuthenticationRealm":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"domain":{"type":"string"}},"required":["name","type"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_privileges","type":"object","properties":{"application":{"type":"string","description":"The name of the application.\nApplication privileges are always associated with exactly one application.","x-found-in":"path"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the privilege.","x-found-in":"path"},"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"}},"required":["application","name"],"description":"Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_privileges","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"},"application":{"type":"string","description":"The name of the application.\nApplication privileges are always associated with exactly one application.","x-found-in":"path"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the privilege.","x-found-in":"path"}},"required":["application","name"],"description":"Delete application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_role","type":"object","properties":{"name":{"type":"string","description":"The name of the role.","x-found-in":"path"},"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"}},"required":["name"],"description":"Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.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"},"name":{"type":"string","description":"The name of the role.","x-found-in":"path"}},"required":["name"],"description":"Delete roles.\n\nDelete roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe delete roles API cannot remove roles that are defined in roles files."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_role_mapping","type":"object","properties":{"name":{"type":"string","description":"The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.","x-found-in":"path"},"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"}},"required":["name"],"description":"Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_role_mapping","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"},"name":{"type":"string","description":"The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.","x-found-in":"path"}},"required":["name"],"description":"Delete role mappings.\n\nRole mappings define which roles are assigned to each user.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files.\nThe delete role mappings API cannot remove role mappings that are defined in role mapping files."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_service_token","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 service name.","x-found-in":"path"},"name":{"type":"string","description":"The name of the service account token.","x-found-in":"path"},"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"}},"required":["namespace","service","name"],"description":"Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.\n\nIMPORTANT: On Serverless, non-operator users can delete tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nDeleting tokens for any other service account requires operator privileges."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_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 namespace, which is a top-level grouping of service accounts.","x-found-in":"path"},"service":{"type":"string","description":"The service name.","x-found-in":"path"},"name":{"type":"string","description":"The name of the service account token.","x-found-in":"path"}},"required":["namespace","service","name"],"description":"Delete service account tokens.\n\nDelete service account tokens for a service in a specified namespace.\n\nIMPORTANT: On Serverless, non-operator users can delete tokens for only `elastic/fleet-server` and `elastic/fleet-server-remote`.\nDeleting tokens for any other service account requires operator privileges."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_user","type":"object","properties":{"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"},"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"}},"required":["username"],"description":"Delete users.\n\nDelete users from the native realm."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.delete_user","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"},"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"}},"required":["username"],"description":"Delete users.\n\nDelete users from the native realm."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.disable_user","type":"object","properties":{"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"},"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"}},"required":["username"],"description":"Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.disable_user","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"},"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"}},"required":["username"],"description":"Disable users.\n\nDisable users in the native realm.\nBy default, when you create users, they are enabled.\nYou can use this API to revoke a user's access to Elasticsearch."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.disable_user_profile","type":"object","properties":{"uid":{"type":"string","description":"Unique identifier for the user profile.","x-found-in":"path"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"}},"required":["uid"],"description":"Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API ."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.disable_user_profile","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', it does nothing with refreshes.","x-found-in":"query"},"uid":{"type":"string","description":"Unique identifier for the user profile.","x-found-in":"path"}},"required":["uid"],"description":"Disable a user profile.\n\nDisable user profiles so that they are not visible in user profile searches.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches.\nTo re-enable a disabled user profile, use the enable user profile API ."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.enable_user","type":"object","properties":{"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"},"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"}},"required":["username"],"description":"Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.enable_user","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"},"username":{"type":"string","description":"An identifier for the user.","x-found-in":"path"}},"required":["username"],"description":"Enable users.\n\nEnable users in the native realm.\nBy default, when you create users, they are enabled."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.enable_user_profile","type":"object","properties":{"uid":{"type":"string","description":"A unique identifier for the user profile.","x-found-in":"path"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.","x-found-in":"query"}},"required":["uid"],"description":"Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.enable_user_profile","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.","x-found-in":"query"},"uid":{"type":"string","description":"A unique identifier for the user profile.","x-found-in":"path"}},"required":["uid"],"description":"Enable a user profile.\n\nEnable user profiles to make them visible in user profile searches.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nWhen you activate a user profile, it's automatically enabled and visible in user profile searches.\nIf you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again."}

package/src/es/json/security.get_role.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.get_role__Role":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"}},"indices":{"type":"array","items":{"$ref":"./security.get_role.json#/$defs/security.get_role__IndicesPrivilegesRead"}},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"description":{"type":"string"},"run_as":{"type":"array","items":{"type":"string"}},"transient_metadata":{"type":"object","additionalProperties":{}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"global":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"required":["cluster","indices","metadata","applications"]},"security.get_role__IndicesPrivilegesRead":{"type":"object","properties":{"implicitly_granted":{"type":"boolean","description":"Set to `true` on entries that were contributed by a registered `ImplicitPrivilegesProvider`\nrather than explicitly stored on the role. Only present when the get role API is called with\n`include_implicit=true`. The put role API rejects this field, so clients must not echo it back\non a GET-then-PUT round-trip."},"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":{"oneOf":[{"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"],"description":"Read-side variant of `IndicesPrivileges` returned by the get role API.\nCarries the `implicitly_granted` marker that is set on entries contributed by\na registered `ImplicitPrivilegesProvider` when `include_implicit` is `true`."}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.get_role__Role":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"}},"indices":{"type":"array","items":{"$ref":"./security.get_role.json#/$defs/security.get_role__IndicesPrivilegesRead"}},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"}},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"description":{"type":"string"},"run_as":{"type":"array","items":{"type":"string"}},"transient_metadata":{"type":"object","additionalProperties":{}},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"}},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"}},"global":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}},"required":["cluster","indices","metadata","applications"]},"security.get_role__IndicesPrivilegesRead":{"type":"object","properties":{"implicitly_granted":{"type":"boolean","description":"Set to `true` on entries that were contributed by a registered `ImplicitPrivilegesProvider`\nrather than explicitly stored on the role. Only present when the get role API is called with\n`include_implicit=true`. The put role API rejects this field, so clients must not echo it back\non a GET-then-PUT round-trip."},"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"],"description":"Read-side variant of `IndicesPrivileges` returned by the get role API.\nCarries the `implicitly_granted` marker that is set on entries contributed by\na registered `ImplicitPrivilegesProvider` when `include_implicit` is `true`."}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_role","type":"object","properties":{"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.","x-found-in":"path"},"include_implicit":{"type":"boolean","description":"If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges.\nEach implicit entry in the response is annotated with `implicitly_granted: true`.","x-found-in":"query"}},"description":"Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_role","type":"object","properties":{"include_implicit":{"type":"boolean","description":"If `true`, include privileges that are implicitly granted by registered `ImplicitPrivilegesProviders` alongside the explicitly configured privileges.\nEach implicit entry in the response is annotated with `implicitly_granted: true`.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"The name of the role.\nYou can specify multiple roles as a comma-separated list.\nIf you do not specify this parameter, the API returns information about all roles.","x-found-in":"path"}},"description":"Get roles.\n\nGet roles in the native realm.\nThe role management APIs are generally the preferred way to manage roles, rather than using file-based role management.\nThe get roles API cannot retrieve roles that are defined in roles files."}

package/src/es/json/security.get_token.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.get_token__AccessTokenGrantType":{"enum":["password","client_credentials","_kerberos","refresh_token"]},"security.get_token__AuthenticatedUser":{"type":"object","properties":{"email":{"oneOf":[{"type":"string"},{"type":"null"}]},"full_name":{"oneOf":[{"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"},"authentication_realm":{"$ref":"./security.get_token.json#/$defs/security.get_token__UserRealm"},"lookup_realm":{"$ref":"./security.get_token.json#/$defs/security.get_token__UserRealm"},"authentication_provider":{"$ref":"./security.get_token.json#/$defs/security.get_token__AuthenticationProvider"},"authentication_type":{"type":"string"}},"required":["metadata","roles","username","enabled","authentication_realm","lookup_realm","authentication_type"]},"security.get_token__UserRealm":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security.get_token__AuthenticationProvider":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"}},"required":["type","name"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.get_token__AccessTokenGrantType":{"enum":["password","client_credentials","_kerberos","refresh_token"]},"security.get_token__AuthenticatedUser":{"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"},"authentication_realm":{"$ref":"./security.get_token.json#/$defs/security.get_token__UserRealm"},"lookup_realm":{"$ref":"./security.get_token.json#/$defs/security.get_token__UserRealm"},"authentication_provider":{"$ref":"./security.get_token.json#/$defs/security.get_token__AuthenticationProvider"},"authentication_type":{"type":"string"}},"required":["metadata","roles","username","enabled","authentication_realm","lookup_realm","authentication_type"]},"security.get_token__UserRealm":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"}},"required":["name","type"]},"security.get_token__AuthenticationProvider":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"}},"required":["type","name"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_user","type":"object","properties":{"username":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.","x-found-in":"path"},"with_profile_uid":{"type":"boolean","description":"Determines whether to retrieve the user profile UID, if it exists, for the users.","x-found-in":"query"}},"description":"Get users.\n\nGet information about users in the native realm and built-in users."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_user","type":"object","properties":{"with_profile_uid":{"type":"boolean","description":"Determines whether to retrieve the user profile UID, if it exists, for the users.","x-found-in":"query"},"username":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users.","x-found-in":"path"}},"description":"Get users.\n\nGet information about users in the native realm and built-in users."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_user_profile","type":"object","properties":{"uid":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A unique identifier for the user profile.","x-found-in":"path"},"data":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default returns no `data` content.","x-found-in":"query"}},"required":["uid"],"description":"Get a user profile.\n\nGet a user's profile using the unique profile ID.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.get_user_profile","type":"object","properties":{"data":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default returns no `data` content.","x-found-in":"query"},"uid":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A unique identifier for the user profile.","x-found-in":"path"}},"required":["uid"],"description":"Get a user profile.\n\nGet a user's profile using the unique profile ID.\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.\nElastic reserves the right to change or remove this feature in future releases without prior notice."}

package/src/es/json/security.grant_api_key.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.grant_api_key__GrantApiKey":{"type":"object","properties":{"name":{"type":"string"},"expiration":{"type":"string","description":"Expiration time for the API key. By default, API keys never expire."},"role_descriptors":{"oneOf":[{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}}}],"description":"The role descriptors for this API key.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token."},"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."}},"required":["name"]},"security.grant_api_key__ApiKeyGrantType":{"enum":["access_token","password"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.grant_api_key__GrantApiKey":{"type":"object","properties":{"name":{"type":"string"},"expiration":{"type":"string","description":"Expiration time for the API key. By default, API keys never expire."},"role_descriptors":{"anyOf":[{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}},{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"}}}],"description":"The role descriptors for this API key.\nWhen it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token.\nIf you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token."},"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."}},"required":["name"]},"security.grant_api_key__ApiKeyGrantType":{"enum":["access_token","password"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.has_privileges","type":"object","properties":{"user":{"type":"string","description":"Username","x-found-in":"path"},"application":{"type":"array","items":{"$ref":"./security.has_privileges.json#/$defs/security.has_privileges__ApplicationPrivilegesCheck"},"x-found-in":"body"},"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of the cluster privileges that you want to check.","x-found-in":"body"},"index":{"type":"array","items":{"$ref":"./security.has_privileges.json#/$defs/security.has_privileges__IndexPrivilegesCheck"},"x-found-in":"body"}},"description":"Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.has_privileges","type":"object","properties":{"application":{"type":"array","items":{"$ref":"./security.has_privileges.json#/$defs/security.has_privileges__ApplicationPrivilegesCheck"},"x-found-in":"body"},"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of the cluster privileges that you want to check.","x-found-in":"body"},"index":{"type":"array","items":{"$ref":"./security.has_privileges.json#/$defs/security.has_privileges__IndexPrivilegesCheck"},"x-found-in":"body"},"user":{"type":"string","description":"Username","x-found-in":"path"}},"description":"Check user privileges.\n\nDetermine whether the specified user has a specified list of privileges.\nAll users can use this API, but only to determine their own privileges.\nTo check the privileges of other users, you must use the run as feature."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_privileges","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"}},"description":"Create or update application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_privileges","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"},"privileges":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"$ref":"./security.put_privileges.json#/$defs/security.put_privileges__Actions"}},"x-found-in":"body"}},"description":"Create or update application privileges.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_security` cluster privilege (or a greater privilege such as `all`).\n* The \"Manage Application Privileges\" global privilege for the application being referenced in the request.\n\nApplication names are formed from a prefix, with an optional suffix that conform to the following rules:\n\n* The prefix must begin with a lowercase ASCII letter.\n* The prefix must contain only ASCII letters or digits.\n* The prefix must be at least 3 characters long.\n* If the suffix exists, it must begin with either a dash `-` or `_`.\n* The suffix cannot contain any of the following characters: `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, `,`, `*`.\n* No part of the name can contain whitespace.\n\nPrivilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`.\n\nAction names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_role","type":"object","properties":{"name":{"type":"string","description":"The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.","x-found-in":"path"},"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"},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries.","x-found-in":"body"},"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 for users with this role.","x-found-in":"body"},"global":{"type":"object","additionalProperties":{},"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.","x-found-in":"body"},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries.","x-found-in":"body"},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of remote indices permissions entries.\n\nNOTE: Remote indices are effective for remote clusters configured with the API key based model.\nThey have no effect for remote clusters configured with the certificate based model.","x-found-in":"body"},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of remote cluster permissions entries.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.","x-found-in":"body"},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.","x-found-in":"body"},"description":{"type":"string","description":"Optional description of the role descriptor","x-found-in":"body"},"transient_metadata":{"type":"object","additionalProperties":{},"description":"Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.","x-found-in":"body"}},"required":["name"],"description":"Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.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"},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries.","x-found-in":"body"},"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 for users with this role.","x-found-in":"body"},"global":{"type":"object","additionalProperties":{},"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges.","x-found-in":"body"},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries.","x-found-in":"body"},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of remote indices permissions entries.\n\nNOTE: Remote indices are effective for remote clusters configured with the API key based model.\nThey have no effect for remote clusters configured with the certificate based model.","x-found-in":"body"},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of remote cluster permissions entries.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional metadata. Within the metadata object, keys that begin with an underscore (`_`) are reserved for system use.","x-found-in":"body"},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the owners of this role can impersonate. *Note*: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected.","x-found-in":"body"},"description":{"type":"string","description":"Optional description of the role descriptor","x-found-in":"body"},"transient_metadata":{"type":"object","additionalProperties":{},"description":"Indicates roles that might be incompatible with the current cluster license, specifically roles with document and field level security. When the cluster license doesn’t allow certain features for a given role, this parameter is updated dynamically to list the incompatible features. If `enabled` is `false`, the role is ignored, but is still listed in the response from the authenticate API.","x-found-in":"body"},"name":{"type":"string","description":"The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role.","x-found-in":"path"}},"required":["name"],"description":"Create or update roles.\n\nThe role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management.\nThe create or update roles API cannot update roles that are defined in roles files.\nFile-based role management is not available in Elastic Serverless."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_role_mapping","type":"object","properties":{"name":{"type":"string","description":"The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.","x-found-in":"path"},"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"},"enabled":{"type":"boolean","description":"Mappings that have `enabled` set to `false` are ignored when role mapping is performed.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"},"roles":{"type":"array","items":{"type":"string"},"description":"A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.","x-found-in":"body"},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"},"description":"A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.","x-found-in":"body"},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule","description":"The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.","x-found-in":"body"},"run_as":{"type":"array","items":{"type":"string"},"x-found-in":"body"}},"required":["name"],"description":"Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_role_mapping","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"},"enabled":{"type":"boolean","description":"Mappings that have `enabled` set to `false` are ignored when role mapping is performed.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Additional metadata that helps define which roles are assigned to each user.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.","x-found-in":"body"},"roles":{"type":"array","items":{"type":"string"},"description":"A list of role names that are granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.","x-found-in":"body"},"role_templates":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RoleTemplate"},"description":"A list of Mustache templates that will be evaluated to determine the roles names that should granted to the users that match the role mapping rules.\nExactly one of `roles` or `role_templates` must be specified.","x-found-in":"body"},"rules":{"$ref":"./security._types.json#/$defs/security._types__RoleMappingRule","description":"The rules that determine which users should be matched by the mapping.\nA rule is a logical condition that is expressed by using a JSON DSL.","x-found-in":"body"},"run_as":{"type":"array","items":{"type":"string"},"x-found-in":"body"},"name":{"type":"string","description":"The distinct name that identifies the role mapping.\nThe name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way.","x-found-in":"path"}},"required":["name"],"description":"Create or update role mappings.\n\nRole mappings define which roles are assigned to each user.\nEach mapping has rules that identify users and a list of roles that are granted to those users.\nThe role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files.\n\nNOTE: This API does not create roles. Rather, it maps users to existing roles.\nRoles can be created by using the create or update roles API or roles files.\n\n**Role templates**\n\nThe most common use for role mappings is to create a mapping from a known value on the user to a fixed role name.\nFor example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch.\nThe `roles` field is used for this purpose.\n\nFor more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user.\nThe `role_templates` field is used for this purpose.\n\nNOTE: To use role templates successfully, the relevant scripting feature must be enabled.\nOtherwise, all attempts to create a role mapping with role templates fail.\n\nAll of the user fields that are available in the role mapping rules are also available in the role templates.\nThus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated.\n\nBy default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user.\nIf the format of the template is set to \"json\" then the template is expected to produce a JSON string or an array of JSON strings for the role names."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_user","type":"object","properties":{"username":{"type":"string","x-found-in":"body"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.","x-found-in":"query"},"email":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The email of the user.","x-found-in":"body"},"full_name":{"oneOf":[{"type":"string"},{"type":"null"}],"description":"The full name of the user.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the user.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.","x-found-in":"body"},"roles":{"type":"array","items":{"type":"string"},"description":"A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).","x-found-in":"body"},"enabled":{"type":"boolean","description":"Specifies whether the user is enabled.","x-found-in":"body"}},"required":["username"],"description":"Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.put_user","type":"object","properties":{"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"Valid values are `true`, `false`, and `wait_for`.\nThese values have the same meaning as in the index API, but the default value for this API is true.","x-found-in":"query"},"username":{"type":"string","description":"An identifier for the user.\n\nNOTE: Usernames must be at least 1 and no more than 507 characters.\nThey can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.\nLeading or trailing whitespace is not allowed.","x-found-in":"path"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The email of the user.","x-found-in":"body"},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The full name of the user.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the user.","x-found-in":"body"},"password":{"type":"string","description":"The user's password.\nPasswords must be at least 6 characters long.\nWhen adding a user, one of `password` or `password_hash` is required.\nWhen updating an existing user, the password is optional, so that other fields on the user (such as their roles) may be updated without modifying the user's password","x-found-in":"body"},"password_hash":{"type":"string","description":"A hash of the user's password.\nThis must be produced using the same hashing algorithm as has been configured for password storage.\nFor more details, see the explanation of the `xpack.security.authc.password_hashing.algorithm` setting in the user cache and password hash algorithm documentation.\nUsing this parameter allows the client to pre-hash the password for performance and/or confidentiality reasons.\nThe `password` parameter and the `password_hash` parameter cannot be used in the same request.","x-found-in":"body"},"roles":{"type":"array","items":{"type":"string"},"description":"A set of roles the user has.\nThe roles determine the user's access permissions.\nTo create a user without any roles, specify an empty list (`[]`).","x-found-in":"body"},"enabled":{"type":"boolean","description":"Specifies whether the user is enabled.","x-found-in":"body"}},"required":["username"],"description":"Create or update users.\n\nAdd and update users in the native realm.\nA password is required for adding a new user but is optional when updating an existing user.\nTo change a user's password without updating any other fields, use the change password API."}