Get a token

  • POST /_security/oauth2/token
Auth

Create a bearer token for access without requiring basic authentication. The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. Alternatively, you can explicitly enable the xpack.security.authc.token.enabled setting. When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface.

The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body.

A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available.

The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. That time period is defined by the xpack.security.authc.token.timeout setting. If you want to invalidate a token immediately, you can do so by using the invalidate token API.

More about setting up https

Required authorization

Cluster privileges manage_token

Request body

grant_type enum

The type of grant. Supported grant types are: password, _kerberos, client_credentials, refresh_token, and _user_managed_service_account.

Supported values include:

  • password: This grant type implements the Resource Owner Password Credentials Grant of OAuth2. In this grant, a trusted client exchanges the end user's credentials for an access token and (possibly) a refresh token. The request needs to be made by an authenticated user but happens on behalf of another authenticated user (the one whose credentials are passed as request parameters). This grant type is not suitable or designed for the self-service user creation of tokens.
  • client_credentials: This grant type implements the Client Credentials Grant of OAuth2. It is geared for machine to machine communication and is not suitable or designed for the self-service user creation of tokens. It generates only access tokens that cannot be refreshed. The premise is that the entity that uses client_credentials has constant access to a set of (client, not end-user) credentials and can authenticate itself at will.
  • _kerberos: This grant type is supported internally and implements SPNEGO based Kerberos support. The _kerberos grant type may change from version to version.
  • refresh_token: This grant type implements the Refresh Token Grant of OAuth2. In this grant a user exchanges a previously issued refresh token for a new access token and a new refresh token.
  • _user_managed_service_account: This grant type is supported internally and exchanges a user-managed service account token for an access token that represents that service account. The request must be made by an authenticated caller with the manage_token cluster privilege, on behalf of the service account whose token is passed in the service_account_token parameter. The service account token is authenticated on every exchange, so a disabled account or an invalidated token is rejected. Tokens that belong to built-in (elastic/*) service accounts are rejected. It generates only access tokens that cannot be refreshed. The _user_managed_service_account grant type may change from version to version.
Values: password client_credentials _kerberos refresh_token _user_managed_service_account
scope string

The scope of the token. Currently tokens are only issued for a scope of FULL regardless of the value sent with the request.

password string

The user's password. If you specify the password grant type, this parameter is required. This parameter is not valid with any other supported grant type.

kerberos_ticket string

The base64 encoded kerberos ticket. If you specify the _kerberos grant type, this parameter is required. This parameter is not valid with any other supported grant type.

refresh_token string

The string that was returned when you created the token, which enables you to extend its life. If you specify the refresh_token grant type, this parameter is required. This parameter is not valid with any other supported grant type.

service_account_token string

The service account token of a user-managed service account, as returned by the create service account token API. If you specify the _user_managed_service_account grant type, this parameter is required. This parameter is not valid with any other supported grant type.

username string

The username that identifies the user. If you specify the password grant type, this parameter is required. This parameter is not valid with any other supported grant type.

Response

application/json
access_token string required
expires_in number required
scope string
type string required
refresh_token string
kerberos_authentication_response_token string
authentication object required
email union string nullable
One of: string
full_name union string nullable
metadata object required
roles string[] required
username string required
enabled boolean required
profile_uid string
authentication_realm object required
name string required
type string required
lookup_realm object required
name string required
type string required
authentication_provider object
type string required
name string required
authentication_type string required
api_key object

Present when the authenticated user is an API key.

id string required
name string
managed_by enum required
Values: cloud elasticsearch
internal boolean
token object

Present when the authenticated user is a service account, or authenticated with a token.

name string
type string
managed_by enum
Values: cloud elasticsearch