Path parameters

• name string | array[string] Required

  The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about all roles.

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • * object Additional properties
    Hide * attributes Show * attributes object

    • cluster array[string] Required
    • indices array[object] Required
      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

        A list of indices (or index name patterns) to which the permissions in this entry apply.

        One of:

        IndexName string array-2 array[string]
      • 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:

        string-1 string QueryContainer object RoleTemplateQuery object

        An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.

        External documentation

        Hide attribute Show attribute

        • template object
    • metadata object Required
      Hide metadata attribute Show metadata attribute object

      • * object Additional properties
    • description string
    • run_as array[string]
    • transient_metadata object
      Hide transient_metadata attribute Show transient_metadata attribute object

      • * object Additional properties
    • applications array[object] Required
      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.

    • role_templates array[object]
      Hide role_templates attributes Show role_templates attributes object

      • format string

        Values are string or json.

      • template object Required
        Hide template attributes Show template attributes object

        • source string | object

          One of:

          string-1 string SearchRequestBody object
        • id string
        • params object

          Specifies any named parameters that are passed into the script as variables. Use parameters instead of hard-coded values to decrease compile time.

          Hide params attribute Show params attribute object

          • * object Additional properties

        • lang string

          Any of:

          string-1 string string-2 string

          Values are painless, expression, mustache, or java.
        • options object
          Hide options attribute Show options attribute object

          • * string Additional properties
    • global object Generally available
      Hide global attribute Show global attribute object

      • * object Additional properties
        Hide * attribute Show * attribute object

        • * object Additional properties
          Hide * attribute Show * attribute object

          • * array[string] Additional properties