lumis.portal.user

Class UserResource

java.lang.Object

lumis.portal.user.UserResource

@StableMinor(version="12.3",
             sinceVersion="8.0")
 @Path(value="/lumis/authentication/users")
public class UserResource
extends Object

REST API related to portal users.

Since:

8.0.0

Version:

$Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

Constructor Summary

Constructors

Constructor and Description
UserResource()

Method Summary

Modifier and Type	Method and Description
UserConfig	getCurrentUser() Returns the current logged in user.
Response	isMember(String groupAlias) Returns true if the user of the given session is member of the group with the given alias or false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserResource

public UserResource()

Method Detail

getCurrentUser

@GET
 @Path(value="/current")
 @Produces(value="application/json")
public UserConfig getCurrentUser()
                                                                                             throws PortalException

Returns the current logged in user. Sample response body:

 {
  "id":"8A488AF9475E73CD01475FEAEC140F88",
  "login":"johnsmith",
  "name":"John Stuart Smith",
  "firstName":"John",
  "middleName":"Stuart",
  "lastName":"Smith",
  "profileImageHref":"http://localhost:8080/portal/lumis/api/rest/lum-internal/users/8A488AF9475E73CD01475FEAEC140F88/profileimage"
 }
 

Returns:

the logged in user.

Throws:

PortalException

Since:

8.0.0

isMember

@Path(value="/current/isMemberOf/{groupAlias:[^/]{1,100}}")
 @GET
 @Produces(value="application/json")
public Response isMember(@PathParam(value="groupAlias") @NotBlank
                                                                                                                                String groupAlias)
                                                                                                                         throws PortalException

Returns true if the user of the given session is member of the group with the given alias or false otherwise.

Parameters:

groupAlias - the group alias.

userSessionId - the user session identifier.

Returns:

true if the user of the given session is member of the group with the given alias or false otherwise.

Throws:

PortalException

Since:

11.1.0