Class ApiKey
java.lang.Object
co.elastic.clients.elasticsearch.security.ApiKey
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ApiKey>
Json deserializer forApiKey
-
Method Summary
Modifier and TypeMethodDescriptionfinal Long
creation()
Creation time for the API key in milliseconds.final Long
Expiration time for the API key in milliseconds.final String
id()
Required - Id for the API keyfinal Boolean
Invalidation status for the API key.final List<Map<String,
RoleDescriptor>> The owner user’s permissions associated with the API key.metadata()
Metadata of the API keyfinal String
name()
Required - Name of the API key.static ApiKey
final String
realm()
Realm name of the principal for which this API key was created.final Map<String,
RoleDescriptor> The role descriptors assigned to this API key when it was created or last updated.void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final List<FieldValue>
sort()
API name:_sort
toString()
final String
username()
Principal for which this API key was created
-
Field Details
-
_DESERIALIZER
Json deserializer forApiKey
-
-
Method Details
-
of
-
creation
Creation time for the API key in milliseconds.API name:
creation
-
expiration
Expiration time for the API key in milliseconds.API name:
expiration
-
id
Required - Id for the API keyAPI name:
id
-
invalidated
Invalidation status for the API key. If the key has been invalidated, it has a value oftrue
. Otherwise, it isfalse
.API name:
invalidated
-
name
Required - Name of the API key.API name:
name
-
realm
Realm name of the principal for which this API key was created.API name:
realm
-
username
Principal for which this API key was createdAPI name:
username
-
metadata
Metadata of the API keyAPI name:
metadata
-
roleDescriptors
The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions.API name:
role_descriptors
-
limitedBy
The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.API name:
limited_by
-
sort
API name:_sort
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupApiKeyDeserializer
-