Interface IAuthentication

All Known Subinterfaces:

IInCoreAuthentication, IInternalAuthentication

@Path("/auth")
public interface IAuthentication

Authentication service

Method Summary

Modifier and Type	Method	Description
void	backchannelLogout(net.bluemind.core.api.Stream contentStream)	Back-channel logout Used for Single-Sign-out from centralized authentication
AuthUser	getCurrentUser()
LoginResponse	login(String login, String password, String origin)	Try to log in user into Blue-Mind and create valid session on success
LoginResponse	loginWithParams(String login, String password, String origin, Boolean interactive)	Try to log in user into Blue-Mind and create valid session on success
void	logout()	Close a Blue-Mind session
void	ping()	Refreshes the session, or throws exception if the SecurityContext is invalid.
LoginResponse	su(String login)	Create Blue-Mind access token for requested user. This token can be used for authenticate against Blue-Mind components
LoginResponse	suWithParams(String login, Boolean interactive)
ValidationKind	validate(String login, String password, String origin)	Validate credential

Method Details

login

@POST
@Path("login")
LoginResponse login(@QueryParam("login")
 String login,
 String password,
 @QueryParam("origin")
 String origin)
             throws net.bluemind.core.api.fault.ServerFault

Try to log in user into Blue-Mind and create valid session on success

Parameters:

login - user login

password - user password

origin - Blue Mind application from which user tries to log in

Returns:

LoginResponse

Throws:

net.bluemind.core.api.fault.ServerFault

loginWithParams

@POST
@Path("loginWithParams")
LoginResponse loginWithParams(@QueryParam("login")
 String login,
 String password,
 @QueryParam("origin")
 String origin,
 @QueryParam("interactive")
 Boolean interactive)
                       throws net.bluemind.core.api.fault.ServerFault

Try to log in user into Blue-Mind and create valid session on success

Parameters:

login - user login

password - user password

origin - Blue Mind application from which user tries to log in

interactive - interactive

Returns:

LoginResponse

Throws:

net.bluemind.core.api.fault.ServerFault

validate

@POST
@Path("validate")
ValidationKind validate(@QueryParam("login")
 String login,
 String password,
 @QueryParam("origin")
 String origin)
                 throws net.bluemind.core.api.fault.ServerFault

Validate credential

Parameters:

login - user login

password - user password

origin - Blue Mind application from which user tries to log in

Returns:

LoginResponse

Throws:

net.bluemind.core.api.fault.ServerFault

ping

@GET
@Path("ping")
void ping()
   throws net.bluemind.core.api.fault.ServerFault

Refreshes the session, or throws exception if the SecurityContext is invalid.

Throws:

net.bluemind.core.api.fault.ServerFault

logout

@POST
@Path("logout")
void logout()
     throws net.bluemind.core.api.fault.ServerFault

Close a Blue-Mind session

Throws:

net.bluemind.core.api.fault.ServerFault

backchannelLogout

@POST
@Path("logout/backchannel")
void backchannelLogout(net.bluemind.core.api.Stream contentStream)

Back-channel logout Used for Single-Sign-out from centralized authentication

su

@POST
@Path("_su")
LoginResponse su(@QueryParam("login")
 String login)
          throws net.bluemind.core.api.fault.ServerFault

Create Blue-Mind access token for requested user.
This token can be used for authenticate against Blue-Mind components

Only token from global domain are allowed to do this.

Parameters:

login - requested login@domain access token

Returns:

LoginResponse

Throws:

net.bluemind.core.api.fault.ServerFault

suWithParams

@POST
@Path("_suWithParams")
LoginResponse suWithParams(@QueryParam("login")
 String login,
 @QueryParam("interactive")
 Boolean interactive)
                    throws net.bluemind.core.api.fault.ServerFault

Throws:

net.bluemind.core.api.fault.ServerFault

getCurrentUser

@GET
AuthUser getCurrentUser()
                 throws net.bluemind.core.api.fault.ServerFault

Throws:

net.bluemind.core.api.fault.ServerFault