Path parameters

  • idstring Required

    The ID of the API key to update.

application/json

Body

  • role_descriptorsobject

    The role descriptors to assign to this API key. The API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user. You can assign new privileges by specifying them in this parameter. To remove assigned privileges, you can supply an empty role_descriptors parameter, that is to say, an empty object {}. If an API key has no assigned privileges, it inherits the owner user's full permissions. The snapshot of the owner's permissions is always updated, whether you supply the role_descriptors parameter or not. The structure of a role descriptor is the same as the request for the create API keys API.

    Hide role_descriptors attribute Show role_descriptors attribute object
    • *object Additional properties
      Hide * attributes Show * attributes object
      • clusterarray[string]

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

      • indicesarray[object]

        A list of indices permissions entries.

        Hide indices attributes Show indices attributes object
        • field_securityobject
          Hide field_security attributes Show field_security attributes object
          • exceptstring | array[string]
          • grantstring | array[string]
        • namesarray[string] Required

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

        • privilegesarray[string] Required

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

        • querystring | 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:
          IndicesPrivilegesQuerystringQueryContainerobjectRoleTemplateQueryobject

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

          External documentation
        • allow_restricted_indicesboolean

          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_indicesarray[object]

        A list of indices permissions for remote clusters.

        Hide remote_indices attributes Show remote_indices attributes object
        • clustersstring | array[string] Required
        • field_securityobject
          Hide field_security attributes Show field_security attributes object
          • exceptstring | array[string]
          • grantstring | array[string]
        • namesarray[string] Required

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

        • privilegesarray[string] Required

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

        • querystring | 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:
          IndicesPrivilegesQuerystringQueryContainerobjectRoleTemplateQueryobject

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

          External documentation
        • allow_restricted_indicesboolean

          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_clusterarray[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
        • clustersstring | array[string] Required
        • privilegesarray[string] Required

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

          Values are monitor_enrich or monitor_stats.

      • globalarray[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-1array[object]GlobalPrivilegeobject
        Hide attribute Show attribute object
        • applicationobject Required
          Hide application attribute Show application attribute object
      • applicationsarray[object]

        A list of application privilege entries

        Hide applications attributes Show applications attributes object
        • applicationstring Required

          The name of the application to which this entry applies.

        • privilegesarray[string] Required

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

        • resourcesarray[string] Required

          A list resources to which the privileges are applied.

      • metadataobject
        Hide metadata attribute Show metadata attribute object
      • run_asarray[string]

        A list of users that the API keys can impersonate. NOTE: In Elastic Cloud 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.

      • descriptionstring

        Optional description of the role descriptor

      • restrictionobject
        Hide restriction attribute Show restriction attribute object
        • workflowsarray[string] Required

          A list of workflows to which the API key is restricted. NOTE: In order to use a role restriction, an API key must be created with a single role descriptor.

      • transient_metadataobject
        Hide transient_metadata attribute Show transient_metadata attribute object
  • metadataobject
    Hide metadata attribute Show metadata attribute object
  • expirationstring

    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.

Responses

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

      If true, the API key was updated. If false, the API key didn't change because no change was detected.

PUT /_security/api_key/{id}
curl \
 --request PUT 'http://api.example.com/_security/api_key/{id}' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '"{\n  \"role_descriptors\": {\n    \"role-a\": {\n      \"indices\": [\n        {\n          \"names\": [\"*\"],\n          \"privileges\": [\"write\"]\n        }\n      ]\n    }\n  },\n  \"metadata\": {\n    \"environment\": {\n      \"level\": 2,\n      \"trusted\": true,\n      \"tags\": [\"production\"]\n    }\n  }\n}"'
Request examples
Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to assign new role descriptors and metadata to an API key.
{
  "role_descriptors": {
    "role-a": {
      "indices": [
        {
          "names": ["*"],
          "privileges": ["write"]
        }
      ]
    }
  },
  "metadata": {
    "environment": {
      "level": 2,
      "trusted": true,
      "tags": ["production"]
    }
  }
}
Run `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx` to remove the API key's previously assigned permissions. It will inherit the owner user's full permissions.
{
  "role_descriptors": {}
}
Response examples (200)
A successful response from `PUT /_security/api_key/VuaCfGcBCdbkQm-e5aOx`. The API key's effective permissions after the update will be the intersection of the supplied role descriptors and the owner user's permissions.
{
  "updated": true
}