Package co.elastic.clients.elasticsearch.security.get_token

Enum Class AccessTokenGrantType

java.lang.Object

java.lang.Enum<AccessTokenGrantType>

co.elastic.clients.elasticsearch.security.get_token.AccessTokenGrantType

All Implemented Interfaces:

JsonEnum, JsonpSerializable, Serializable, Comparable<AccessTokenGrantType>, Constable

@JsonpDeserializable
public enum AccessTokenGrantType
extends Enum<AccessTokenGrantType>
implements JsonEnum

See Also:

• API specification

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface co.elastic.clients.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ClientCredentials	This grant type implements the Client Credentials Grant of OAuth2.
Kerberos	This grant type is supported internally and implements SPNEGO based Kerberos support.
Password	This grant type implements the Resource Owner Password Credentials Grant of OAuth2.
RefreshToken	This grant type implements the Refresh Token Grant of OAuth2.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonEnum.Deserializer<AccessTokenGrantType>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
String	jsonValue()
static AccessTokenGrantType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AccessTokenGrantType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.JsonEnum

aliases, serialize

Enum Constant Details

Password

public static final AccessTokenGrantType 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.

ClientCredentials

public static final AccessTokenGrantType ClientCredentials

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

public static final AccessTokenGrantType Kerberos

This grant type is supported internally and implements SPNEGO based Kerberos support. The _kerberos grant type may change from version to version.

RefreshToken

public static final AccessTokenGrantType RefreshToken

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.

Field Details

_DESERIALIZER

public static final JsonEnum.Deserializer<AccessTokenGrantType> _DESERIALIZER

Method Details

values

public static AccessTokenGrantType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AccessTokenGrantType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

jsonValue

public String jsonValue()

Specified by:

jsonValue in interface JsonEnum