Stay organized with collections
Save and categorize content based on your preferences.
com.google.api.server.spi.config
Interface Authenticator
public interface Authenticator
Interface for Endpoints authenticators. To create a custom authenticator, implement and assign
your authenticator class in the authenticator configuration property.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-07-28 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eAuthenticator\u003c/code\u003e interface is used for creating custom authentication mechanisms in Endpoints.\u003c/p\u003e\n"],["\u003cp\u003eImplementers must define their authenticator class and assign it to the \u003ccode\u003eauthenticator\u003c/code\u003e configuration property.\u003c/p\u003e\n"],["\u003cp\u003eThe core method \u003ccode\u003eauthenticate(HttpServletRequest request)\u003c/code\u003e handles user authentication from an HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eauthenticate\u003c/code\u003e method either returns the authenticated \u003ccode\u003eUser\u003c/code\u003e or \u003ccode\u003enull\u003c/code\u003e if no authentication is present or successful.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eauthenticate\u003c/code\u003e method will throw \u003ccode\u003eServiceException\u003c/code\u003e when appropriate.\u003c/p\u003e\n"]]],[],null,["# Authenticator\n\ncom.google.api.server.spi.config\n\nInterface Authenticator\n-----------------------\n\n-\n\n *** ** * ** ***\n\n \u003cbr /\u003e\n\n ```\n public interface Authenticator\n ``` \nInterface for Endpoints authenticators. To create a custom authenticator, implement and assign your authenticator class in the `authenticator` configuration property. \n-\n -\n\n ### Method Summary\n\n-\n -\n\n ### Method Detail\n\n\n -\n\n #### authenticate\n\n ```\n User authenticate(HttpServletRequest request)\n throws ServiceException\n ``` \n Authenticates the user from `request`.\n\n Returns:\n : The authenticated user or null if there is no auth or auth has failed.\n\n Throws:\n : `ServiceException`"]]
