Interface CustomTokenAuthenticator

All Superinterfaces:
CustomAuthenticator

public interface CustomTokenAuthenticator extends CustomAuthenticator
Represents a custom authenticator that supports access token authentication method.
  • Method Details

    • extractGrantAccessToken

      @Nullable default AuthenticationToken extractGrantAccessToken(Grant grant)
      Called to extract AuthenticationToken for the Grant.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 null if 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