Class InvalidateApiKeyRequest
- java.lang.Object
-
- org.elasticsearch.client.security.InvalidateApiKeyRequest
-
- All Implemented Interfaces:
Validatable,ToXContent,ToXContentObject
public final class InvalidateApiKeyRequest extends Object implements Validatable, 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
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static InvalidateApiKeyRequestforOwnedApiKeys()Creates invalidate api key request to invalidate api keys owned by the current authenticated user.StringgetId()StringgetName()StringgetRealmName()StringgetUserName()booleanownedByAuthenticatedUser()XContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)static InvalidateApiKeyRequestusingApiKeyId(String apiKeyId, boolean ownedByAuthenticatedUser)Creates invalidate API key request for given api key idstatic InvalidateApiKeyRequestusingApiKeyName(String apiKeyName, boolean ownedByAuthenticatedUser)Creates invalidate API key request for given api key namestatic InvalidateApiKeyRequestusingRealmAndUserName(String realmName, String userName)Creates invalidate API key request for given realm and user namestatic InvalidateApiKeyRequestusingRealmName(String realmName)Creates invalidate API key request for given realm namestatic InvalidateApiKeyRequestusingUserName(String userName)Creates invalidate API key request for given user name-
Methods 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 Detail
-
getRealmName
public String getRealmName()
-
getUserName
public String getUserName()
-
getId
public String getId()
-
getName
public String getName()
-
ownedByAuthenticatedUser
public boolean ownedByAuthenticatedUser()
-
usingRealmName
public static InvalidateApiKeyRequest usingRealmName(String realmName)
Creates invalidate API key request for given realm name- Parameters:
realmName- realm name- Returns:
InvalidateApiKeyRequest
-
usingUserName
public static InvalidateApiKeyRequest usingUserName(String userName)
Creates invalidate API key request for given user name- Parameters:
userName- user name- Returns:
InvalidateApiKeyRequest
-
usingRealmAndUserName
public static InvalidateApiKeyRequest usingRealmAndUserName(String realmName, 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(String apiKeyId, boolean ownedByAuthenticatedUser)
Creates invalidate API key request for given api key id- Parameters:
apiKeyId- api key idownedByAuthenticatedUser- settrueif the request is only for the API keys owned by current authenticated user elsefalse- Returns:
InvalidateApiKeyRequest
-
usingApiKeyName
public static InvalidateApiKeyRequest usingApiKeyName(String apiKeyName, boolean ownedByAuthenticatedUser)
Creates invalidate API key request for given api key name- Parameters:
apiKeyName- api key nameownedByAuthenticatedUser- settrueif the request is only for the API keys owned by current authenticated user elsefalse- Returns:
InvalidateApiKeyRequest
-
forOwnedApiKeys
public static InvalidateApiKeyRequest forOwnedApiKeys()
Creates invalidate api key request to invalidate api keys owned by the current authenticated user.
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
-