Class AuthenticateResponse

java.lang.Object
org.elasticsearch.client.security.AuthenticateResponse
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

public final class AuthenticateResponse
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject
The response for the authenticate call. The response contains two fields: a user field and a boolean flag signaling if the user is enabled or not. The user object contains all user metadata which Elasticsearch uses to map roles, etc.
  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  AuthenticateResponse.RealmInfo  

    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
  • Constructor Summary

    Constructors
    Constructor Description
    AuthenticateResponse​(User user, boolean enabled, AuthenticateResponse.RealmInfo authenticationRealm, AuthenticateResponse.RealmInfo lookupRealm, java.lang.String authenticationType)  
  • Method Summary

    Modifier and Type Method Description
    boolean enabled()  
    boolean equals​(java.lang.Object o)  
    static AuthenticateResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    AuthenticateResponse.RealmInfo getAuthenticationRealm()  
    java.lang.String getAuthenticationType()  
    AuthenticateResponse.RealmInfo getLookupRealm()  
    User getUser()  
    int hashCode()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment
  • Constructor Details

  • Method Details

    • getUser

      public User getUser()
      Returns:
      The effective user. This is the authenticated user, or, when submitting requests on behalf of other users, it is the impersonated user.
    • enabled

      public boolean enabled()
      Returns:
      whether the user is enabled or not
    • getAuthenticationRealm

      public AuthenticateResponse.RealmInfo getAuthenticationRealm()
      Returns:
      the realm that authenticated the user
    • getLookupRealm

      public AuthenticateResponse.RealmInfo getLookupRealm()
      Returns:
      the realm where the user information was looked up
    • getAuthenticationType

      public java.lang.String getAuthenticationType()
    • 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 interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException
    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object
    • fromXContent

      public static AuthenticateResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException