Body

• role_descriptors object
  Hide role_descriptors attributes Show role_descriptors attributes object

  • Additional properties
  • cluster array[string]

    A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

  • indices array[object]

    A list of indices permissions entries.

    Hide indices attributes Show indices attributes object

    • field_security object
      Hide field_security attributes Show field_security attributes object

      • except string | array[string]
      • grant string | array[string]
    • names string | array[string] Required
    • privileges array[string] Required

      The index level privileges that owners of the role have on the specified indices.

    • query string | object

      While creating or updating a role you can provide either a JSON structure or a string to the API. However, the response provided by Elasticsearch will only be string with a json-as-text content.

      Since this is embedded in IndicesPrivileges, the same structure is used for clarity in both contexts.

      One of:

      _types:IndicesPrivilegesQuery string query_dsl:QueryContainer object _types:RoleTemplateQuery object

      Hide attributes Show attributes

      • bool
      • boosting
      • common object Deprecated
      • combined_fields
      • constant_score
      • dis_max
      • distance_feature
      • exists
      • function_score
      • fuzzy object

        Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.

      • geo_bounding_box
      • geo_distance
      • geo_polygon
      • geo_shape
      • has_child
      • has_parent
      • ids
      • intervals object

        Returns documents based on the order and proximity of matching terms.

      • knn
      • match object

        Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.

      • match_all
      • match_bool_prefix object

        Analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

      • match_none
      • match_phrase object

        Analyzes the text and creates a phrase query out of the analyzed text.

      • match_phrase_prefix object

        Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.

      • more_like_this
      • multi_match
      • nested
      • parent_id
      • percolate
      • pinned
      • prefix object

        Returns documents that contain a specific prefix in a provided field.

      • query_string
      • range object

        Returns documents that contain terms within a provided range.

      • rank_feature
      • regexp object

        Returns documents that contain terms matching a regular expression.

      • rule
      • script
      • script_score
      • semantic
      • shape
      • simple_query_string
      • span_containing
      • span_field_masking
      • span_first
      • span_multi
      • span_near
      • span_not
      • span_or
      • span_term object

        Matches spans containing a term.

      • span_within
      • sparse_vector
      • term object

        Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.

      • terms
      • terms_set object

        Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.

      • text_expansion object Deprecated

        Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.

      • weighted_tokens object Deprecated

        Supports returning text_expansion query results by sending in precomputed tokens with the query.

      • wildcard object

        Returns documents that contain terms matching a wildcard pattern.

      • wrapper
      • type

      Hide attribute Show attribute

      • template object
  • applications array[object]

    A list of application privilege entries

    Hide applications attributes Show applications attributes object

    • application string Required

      The name of the application to which this entry applies.

    • privileges array[string] Required

      A list of strings, where each element is the name of an application privilege or action.

    • resources array[string] Required

      A list resources to which the privileges are applied.

  • metadata object
    Hide metadata attributes Show metadata attributes object

    • Additional properties
    • key object
  • run_as array[string]

    A list of users that the API keys 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.

  • description string

    Optional description of the role descriptor

  • transient_metadata object
    Hide transient_metadata attributes Show transient_metadata attributes object

    • Additional properties
    • key object
• metadata object
  Hide metadata attributes Show metadata attributes object

  • Additional properties
  • key object
• expiration string

  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.