Class InvalidateApiKeyRequest
java.lang.Object
org.elasticsearch.client.security.InvalidateApiKeyRequest
- All Implemented Interfaces:
Validatable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
public final class InvalidateApiKeyRequest extends java.lang.Object implements Validatable, org.elasticsearch.common.xcontent.ToXContentObject
Request for invalidating API key(s) so that it can no longer be used
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
-
Field Summary
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Method Summary
Modifier and Type Method Description static InvalidateApiKeyRequest
forOwnedApiKeys()
Creates invalidate api key request to invalidate api keys owned by the current authenticated user.java.lang.String
getId()
Deprecated.java.util.List<java.lang.String>
getIds()
java.lang.String
getName()
java.lang.String
getRealmName()
java.lang.String
getUserName()
boolean
ownedByAuthenticatedUser()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static InvalidateApiKeyRequest
usingApiKeyId(java.lang.String apiKeyId, boolean ownedByAuthenticatedUser)
Creates invalidate API key request for given api key idstatic InvalidateApiKeyRequest
usingApiKeyIds(java.util.List<java.lang.String> apiKeyIds, boolean ownedByAuthenticatedUser)
Creates invalidate API key request for given api key idsstatic InvalidateApiKeyRequest
usingApiKeyName(java.lang.String apiKeyName, boolean ownedByAuthenticatedUser)
Creates invalidate API key request for given api key namestatic InvalidateApiKeyRequest
usingRealmAndUserName(java.lang.String realmName, java.lang.String userName)
Creates invalidate API key request for given realm and user namestatic InvalidateApiKeyRequest
usingRealmName(java.lang.String realmName)
Creates invalidate API key request for given realm namestatic InvalidateApiKeyRequest
usingUserName(java.lang.String userName)
Creates invalidate API key request for given user nameMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
Method Details
-
getRealmName
public java.lang.String getRealmName() -
getUserName
public java.lang.String getUserName() -
getId
@Deprecated public java.lang.String getId()Deprecated. -
getIds
public java.util.List<java.lang.String> getIds() -
getName
public java.lang.String getName() -
ownedByAuthenticatedUser
public boolean ownedByAuthenticatedUser() -
usingRealmName
Creates invalidate API key request for given realm name- Parameters:
realmName
- realm name- Returns:
InvalidateApiKeyRequest
-
usingUserName
Creates invalidate API key request for given user name- Parameters:
userName
- user name- Returns:
InvalidateApiKeyRequest
-
usingRealmAndUserName
public static InvalidateApiKeyRequest usingRealmAndUserName(java.lang.String realmName, java.lang.String userName)Creates invalidate API key request for given realm and user name- Parameters:
realmName
- realm nameuserName
- user name- Returns:
InvalidateApiKeyRequest
-
usingApiKeyId
public static InvalidateApiKeyRequest usingApiKeyId(java.lang.String apiKeyId, boolean ownedByAuthenticatedUser)Creates invalidate API key request for given api key id- Parameters:
apiKeyId
- api key idownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
usingApiKeyIds
public static InvalidateApiKeyRequest usingApiKeyIds(java.util.List<java.lang.String> apiKeyIds, boolean ownedByAuthenticatedUser)Creates invalidate API key request for given api key ids- Parameters:
apiKeyIds
- api key idsownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
usingApiKeyName
public static InvalidateApiKeyRequest usingApiKeyName(java.lang.String apiKeyName, boolean ownedByAuthenticatedUser)Creates invalidate API key request for given api key name- Parameters:
apiKeyName
- api key nameownedByAuthenticatedUser
- settrue
if the request is only for the API keys owned by current authenticated user elsefalse
- Returns:
InvalidateApiKeyRequest
-
forOwnedApiKeys
Creates invalidate api key request to invalidate api keys owned by the current authenticated user. -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-