Module org.elasticsearch.xcore
Interface CustomTokenAuthenticator
- All Superinterfaces:
CustomAuthenticator
Represents a custom authenticator that supports access token authentication method.
-
Method Summary
Modifier and TypeMethodDescriptiondefault AuthenticationTokenextractGrantAccessToken(Grant grant) Called to extractAuthenticationTokenfor theGrant.ACCESS_TOKEN_GRANT_TYPE.Methods inherited from interface org.elasticsearch.xpack.core.security.authc.CustomAuthenticator
authenticate, extractToken, supports
-
Method Details
-
extractGrantAccessToken
Called to extractAuthenticationTokenfor theGrant.ACCESS_TOKEN_GRANT_TYPE.Note: Currently, this method is only called to extract token during user profile activation. The extracted token will be used to call the
CustomAuthenticator.authenticate(AuthenticationToken, ActionListener)method, before creating a user profile.To opt-out, implementors should return
nullif profile activation is not supported.- Parameters:
grant- grant that holds end-user credentials- Returns:
- an authentication token if grant holds credentials that are supported by this authenticator
-