Grant an API key | Elasticsearch API documentation (v8)

Grant an API key Added in 7.9.0

POST /_security/api_key/grant

Create an API key on behalf of another user. This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. The caller must have authentication credentials for the user on whose behalf the API key will be created. It is not possible to use this API to create an API key without that user's credentials. The supported user authentication credential types are:

username and password
Elasticsearch access tokens
JWTs

The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. In this case, the API key will be created on behalf of the impersonated user.

This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. The API keys are created by the Elasticsearch API key service, which is automatically enabled.

A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. If applicable, it also returns expiration information for the API key in milliseconds.

By default, API keys never expire. You can specify expiration information when you create the API keys.

application/json

Body Required

api_key object Required

Additional properties are allowed.
Hide api_key attributes Show api_key attributes object
- name string Required
- expiration string
  
  A date histogram interval. Similar to Duration with additional units: w (week), M (month), q (quarter) and y (year)
- role_descriptors object | array[object]
  
  The role descriptors for this API key. When it is not specified or is an empty array, the API key has a point in time snapshot of permissions of the specified user or access token. If you supply role descriptors, the resultant permissions are an intersection of API keys permissions and the permissions of the user or access token.
  
  One of:
  object-1 object array-2 array[object]
  
  Hide attribute Show attribute
  
  * 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.
  
  names
  
  privileges array[string] Required
  
  The index level privileges that owners of the role have on the specified indices.
  
  query
  
  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.
  
  names
  
  privileges array[string] Required
  
  The index level privileges that owners of the role have on the specified indices.
  
  query
  
  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
  
  Additional properties are allowed.
  
  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 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.
  
  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
  
  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_metadata object
  
  Hide transient_metadata attribute Show transient_metadata attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  Hide attribute Show 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.
  
  Additional properties are allowed.
  
  remote_indices array[object]
  
  A list of indices permissions for remote clusters.
  
  Additional properties are allowed.
  
  remote_cluster array[object]
  
  A list of cluster permissions for remote clusters. NOTE: This is limited a subset of the cluster permissions.
  
  Additional properties are allowed.
  
  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
  
  Additional properties are allowed.
  
  applications array[object]
  
  A list of application privilege entries
  
  Additional properties are allowed.
  
  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 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.
  
  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
  
  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_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.
grant_type string Required

Values are access_token or password.
access_token string

The user's access token. If you specify the access_token grant type, this parameter is required. It is not valid with other grant types.
username string
password string
run_as string

Responses

200 application/json
Hide response attributes Show response attributes object
- api_key string Required
- id string Required
- name string Required
- expiration number
  
  Time unit for milliseconds
- encoded string Required

POST /_security/api_key/grant

curl \
 --request POST http://api.example.com/_security/api_key/grant \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"api_key":{"name":"string","expiration":"string","role_descriptors":{"additionalProperty1":{"cluster":["string"],"indices":[{"field_security":{},"privileges":["string"],"allow_restricted_indices":true}],"remote_indices":[{"clusters":"string","field_security":{},"privileges":["string"],"allow_restricted_indices":true}],"remote_cluster":[{"clusters":"string","privileges":["monitor_enrich"]}],"global":[{}],"applications":[{"application":"string","privileges":["string"],"resources":["string"]}],"metadata":{"additionalProperty1":{},"additionalProperty2":{}},"run_as":["string"],"description":"string","restriction":{"workflows":["string"]},"transient_metadata":{"additionalProperty1":{},"additionalProperty2":{}}},"additionalProperty2":{"cluster":["string"],"indices":[{"field_security":{},"privileges":["string"],"allow_restricted_indices":true}],"remote_indices":[{"clusters":"string","field_security":{},"privileges":["string"],"allow_restricted_indices":true}],"remote_cluster":[{"clusters":"string","privileges":["monitor_enrich"]}],"global":[{}],"applications":[{"application":"string","privileges":["string"],"resources":["string"]}],"metadata":{"additionalProperty1":{},"additionalProperty2":{}},"run_as":["string"],"description":"string","restriction":{"workflows":["string"]},"transient_metadata":{"additionalProperty1":{},"additionalProperty2":{}}}},"metadata":{"additionalProperty1":{},"additionalProperty2":{}}},"grant_type":"access_token","access_token":"string","username":"string","password":"string","run_as":"string"}'

Request examples

{
  "api_key": {
    "name": "string",
    "expiration": "string",
    "role_descriptors": {
      "additionalProperty1": {
        "cluster": [
          "string"
        ],
        "indices": [
          {
            "field_security": {},
            "privileges": [
              "string"
            ],
            "allow_restricted_indices": true
          }
        ],
        "remote_indices": [
          {
            "clusters": "string",
            "field_security": {},
            "privileges": [
              "string"
            ],
            "allow_restricted_indices": true
          }
        ],
        "remote_cluster": [
          {
            "clusters": "string",
            "privileges": [
              "monitor_enrich"
            ]
          }
        ],
        "global": [
          {}
        ],
        "applications": [
          {
            "application": "string",
            "privileges": [
              "string"
            ],
            "resources": [
              "string"
            ]
          }
        ],
        "metadata": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "run_as": [
          "string"
        ],
        "description": "string",
        "restriction": {
          "workflows": [
            "string"
          ]
        },
        "transient_metadata": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      },
      "additionalProperty2": {
        "cluster": [
          "string"
        ],
        "indices": [
          {
            "field_security": {},
            "privileges": [
              "string"
            ],
            "allow_restricted_indices": true
          }
        ],
        "remote_indices": [
          {
            "clusters": "string",
            "field_security": {},
            "privileges": [
              "string"
            ],
            "allow_restricted_indices": true
          }
        ],
        "remote_cluster": [
          {
            "clusters": "string",
            "privileges": [
              "monitor_enrich"
            ]
          }
        ],
        "global": [
          {}
        ],
        "applications": [
          {
            "application": "string",
            "privileges": [
              "string"
            ],
            "resources": [
              "string"
            ]
          }
        ],
        "metadata": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        },
        "run_as": [
          "string"
        ],
        "description": "string",
        "restriction": {
          "workflows": [
            "string"
          ]
        },
        "transient_metadata": {
          "additionalProperty1": {},
          "additionalProperty2": {}
        }
      }
    },
    "metadata": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    }
  },
  "grant_type": "access_token",
  "access_token": "string",
  "username": "string",
  "password": "string",
  "run_as": "string"
}

Response examples (200)

{
  "api_key": "string",
  "id": "string",
  "name": "string",
  "": 42.0,
  "encoded": "string"
}

Grant an API key Added in 7.9.0

Body Required

role_descriptors object | array[object]

global array[object] | object

Responses