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

    Additional properties are allowed.

    Hide * attributes Show * attributes object

    • cluster array[string] Required
    • indices array[object] Required
      Hide indices attributes Show indices attributes object

      • field_security object

        Additional properties are allowed.

        Hide field_security attributes Show field_security attributes object

        • except string | array[string]
        • grant string | array[string]

      • names string | array[string]

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

        One of:

        _types: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:

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

        Additional properties are allowed.

        External documentation

        Hide attribute Show attribute

        • template object

          Additional properties are allowed.

      • allow_restricted_indices boolean

        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.

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

      • clusters string | array[string] Required
      • field_security object

        Additional properties are allowed.

        Hide field_security attributes Show field_security attributes object

        • except string | array[string]
        • grant string | array[string]

      • names string | array[string]

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

        One of:

        _types: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:

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

        Additional properties are allowed.

        External documentation

        Hide attribute Show attribute

        • template object

          Additional properties are allowed.

      • allow_restricted_indices boolean

        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.

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

      • clusters string | array[string] Required
      • privileges array[string] Required

        The cluster level privileges that owners of the role have on the remote cluster.

        Values are monitor_enrich or monitor_stats.

    • metadata object Required
      Hide metadata attribute Show metadata attribute object

      • * object Additional properties

        Additional properties are allowed.

    • run_as array[string] Required
    • transient_metadata object
      Hide transient_metadata attribute Show transient_metadata attribute object

      • * object Additional properties

        Additional properties are allowed.

    • 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

        Additional properties are allowed.

        Hide template attributes Show template attributes object

        • source string

          The script source.

        • 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

            Additional properties are allowed.

        • lang string

          Any of:

          _types:ScriptLanguage string _types:ScriptLanguage string

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

          • * string Additional properties
    • global object
      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