Package org.elasticsearch.client.security

Class InvalidateApiKeyRequest

java.lang.Object
org.elasticsearch.client.security.InvalidateApiKeyRequest
All Implemented Interfaces:
Validatable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public final class InvalidateApiKeyRequest extends Object implements Validatable, org.elasticsearch.xcontent.ToXContentObject
Request for invalidating API key(s) so that it can no longer be used

  • Method Details

    • getRealmName

      public String getRealmName()

    • getUserName

      public String getUserName()

    • getId

      @Deprecated public String getId()
      Deprecated.

    • getIds

      public List<String> getIds()

    • 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 name
      userName - 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 id
      ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false
      Returns:
      InvalidateApiKeyRequest

    • usingApiKeyIds

      public static InvalidateApiKeyRequest usingApiKeyIds(List<String> apiKeyIds, boolean ownedByAuthenticatedUser)
      Creates invalidate API key request for given api key ids
      Parameters:
      apiKeyIds - api key ids
      ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false
      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 name
      ownedByAuthenticatedUser - set true if the request is only for the API keys owned by current authenticated user else false
      Returns:
      InvalidateApiKeyRequest

    • forOwnedApiKeys

      public static InvalidateApiKeyRequest forOwnedApiKeys()
      Creates invalidate api key request to invalidate api keys owned by the current authenticated user.

    • toXContent

      public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.ToXContent
      Throws:
      IOException