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

Class UserEndpoint

java.lang.Object

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

@Path("/users")
public class UserEndpoint
extends Object

REST endpoint providing user profile information and preferences for authenticated users.

Constructor Summary

Constructors

Constructor	Description
UserEndpoint()

Method Summary

Modifier and Type	Method	Description
Response	getUserInfo()	Returns the client IP address and, if a user is logged in, the current user's information.

Methods inherited from class java.lang.Object

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

Constructor Details

UserEndpoint

public UserEndpoint()

Method Details

getUserInfo

@Path("/current")
@GET
@Produces("application/json")
@Consumes("application/x-www-form-urlencoded")
public Response getUserInfo()

Returns the client IP address and, if a user is logged in, the current user's information.

When no user is authenticated, the user field is omitted from the response.

Returns:

a Response object containing a CurrentUserResponse