Package io.goobi.viewer.api.rest.v1.authentication

Class AuthenticationEndpoint

java.lang.Object

io.goobi.viewer.api.rest.v1.authentication.AuthenticationEndpoint

@Path("/auth")
public class AuthenticationEndpoint
extends Object

REST endpoint handling user authentication, login/logout flows, and OAuth-based API token management.

Constructor Summary

Constructors

Constructor	Description
AuthenticationEndpoint()

Method Summary

Modifier and Type	Method	Description
Response	authenticateUser(String email, String password)	authenticateUser.
Response	headerParameterLogin(String redirectUrl)
Response	openIdLoginGET(String error, String authCode, String accessToken, String state)
Response	openIdLoginPOST()	OpenID Connect POST callback.

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationEndpoint

public AuthenticationEndpoint()

Method Details

authenticateUser

@POST
@Produces("application/json")
@Consumes("application/x-www-form-urlencoded")
public Response authenticateUser(@FormParam("email")
 String email,
 @FormParam("password")
 String password)

authenticateUser.

Parameters:

email - user email address for authentication

password - user password for authentication

Returns:

the HTTP response containing the authentication token on success, or a 403/500 status on failure

headerParameterLogin

@GET
@Path("/header")
public Response headerParameterLogin(@QueryParam("redirectUrl")
 String redirectUrl)

Parameters:

redirectUrl - optional URL to redirect to after login

Returns:

Response

openIdLoginGET

@GET
@Path("/oauth")
public Response openIdLoginGET(@QueryParam("error")
 String error,
 @QueryParam("code")
 String authCode,
 @QueryParam("id_token")
 String accessToken,
 @QueryParam("state")
 String state)
                        throws IOException

Parameters:

error - error code returned by the OpenID provider on failure

authCode - authorization code from the OpenID provider

accessToken - ID token passed directly by the provider

state - state value to match against the registered provider

Returns:

Response

Throws:

IOException

openIdLoginPOST

@POST
@Path("/oauth")
@Consumes("application/x-www-form-urlencoded")
public Response openIdLoginPOST()
                         throws IOException

OpenID Connect POST callback. Parameters are read from the request body via ServletRequest.getParameter(String) to avoid Jersey throwing IllegalStateException when Content-Type is absent.

Returns:

Response

Throws:

IOException