Body Required

• 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.

• name string
• role_descriptors object

  An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.

  Hide role_descriptors attribute Show role_descriptors attribute object

  • * object Additional properties

    Additional properties are allowed.

    Hide * attributes Show * attributes object

    • 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

        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]

      A list of indices permissions for remote clusters.

      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]

      A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions.

      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.

    • global array[object] | object

      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.

      One of:

      array-1 array[object] _types:GlobalPrivilege object

      Hide attribute Show attribute object

      • application object Required

        Additional properties are allowed.

        Hide application attribute Show application attribute object

        • manage object Required

          Additional properties are allowed.

      Hide attribute Show attribute

      • application object Required

        Additional properties are allowed.

        Hide application attribute Show application attribute object

        • manage object Required

          Additional properties are allowed.

          Hide manage attribute Show manage attribute object

          • applications array[string] Required
    • 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 attribute Show metadata attribute object

      • * object Additional properties

        Additional properties are allowed.

    • 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

    • restriction object

      Additional properties are allowed.

      Hide restriction attribute Show restriction attribute object

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

      • * object Additional properties

        Additional properties are allowed.

• metadata object
  Hide metadata attribute Show metadata attribute object

  • * object Additional properties

    Additional properties are allowed.