Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.security.action.apikey

Class ApiKey

java.lang.Object

org.elasticsearch.xpack.core.security.action.apikey.ApiKey

All Implemented Interfaces:

ToXContent, ToXContentObject

public final class ApiKey
extends Object
implements ToXContentObject

API key information

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiKey.Type
static final record	ApiKey.Version
static class	ApiKey.VersionComponent

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static final ApiKey.Version	CURRENT_API_KEY_VERSION

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ApiKey(String name, String id, ApiKey.Type type, Instant creation, Instant expiration, boolean invalidated, Instant invalidation, String username, String realm, String realmType, Map<String,Object> metadata, List<RoleDescriptor> roleDescriptors, List<RoleDescriptor> limitedByRoleDescriptors, String certificateIdentity)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static ApiKey	fromXContent(XContentParser parser)
String	getCertificateIdentity()
Instant	getCreation()
Instant	getExpiration()
String	getId()
Instant	getInvalidation()
RoleDescriptorsIntersection	getLimitedBy()
Map<String,Object>	getMetadata()
String	getName()
String	getRealm()
RealmConfig.RealmIdentifier	getRealmIdentifier()
String	getRealmType()
List<RoleDescriptor>	getRoleDescriptors()
ApiKey.Type	getType()
String	getUsername()
int	hashCode()
XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)
boolean	isInvalidated()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

CURRENT_API_KEY_VERSION

public static final ApiKey.Version CURRENT_API_KEY_VERSION

Constructor Details

ApiKey

public ApiKey(String name,
 String id,
 ApiKey.Type type,
 Instant creation,
 Instant expiration,
 boolean invalidated,
 @Nullable
 Instant invalidation,
 String username,
 String realm,
 @Nullable
 String realmType,
 @Nullable
 Map<String,Object> metadata,
 @Nullable
 List<RoleDescriptor> roleDescriptors,
 @Nullable
 List<RoleDescriptor> limitedByRoleDescriptors,
 @Nullable
 String certificateIdentity)

Method Details

getId

public String getId()

getName

public String getName()

getType

public ApiKey.Type getType()

getCreation

public Instant getCreation()

getExpiration

public Instant getExpiration()

isInvalidated

public boolean isInvalidated()

getInvalidation

public Instant getInvalidation()

getUsername

public String getUsername()

getRealm

public String getRealm()

getRealmType

@Nullable
public String getRealmType()

getRealmIdentifier

@Nullable
public RealmConfig.RealmIdentifier getRealmIdentifier()

getMetadata

public Map<String,Object> getMetadata()

getRoleDescriptors

public List<RoleDescriptor> getRoleDescriptors()

getLimitedBy

public RoleDescriptorsIntersection getLimitedBy()

getCertificateIdentity

@Nullable
public String getCertificateIdentity()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

innerToXContent

public XContentBuilder innerToXContent(XContentBuilder builder,
 ToXContent.Params params)
                                throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

fromXContent

public static ApiKey fromXContent(XContentParser parser)
                           throws IOException

Throws:

IOException