com.atlassian.crowd.plugin.rest.service.resource.usermanagement

Class AuthenticationResource

java.lang.Object

com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

com.atlassian.crowd.plugin.rest.service.resource.usermanagement.AuthenticationResource

@Path(value="authentication")
 @Produces(value={"application/xml","application/json"})
 @Consumes(value={"application/xml","application/json"})
public class AuthenticationResource
extends AbstractResource

User Authentication Resource.

Field Summary

Fields inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

request, uriInfo

Constructor Summary

Constructors

Constructor and Description
AuthenticationResource(AuthenticationController authenticationController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	authenticateUser(String username, PasswordEntity password) Authenticates a user.
javax.ws.rs.core.Response	userAuthenticated(String username) Notifies Crowd that a user has logged into an application, using a method different than the default /authentication or /session resources.

Methods inherited from class com.atlassian.crowd.plugin.rest.service.resource.AbstractResource

getApplicationName, getBaseUri, setApplicationName, setRequest, setUriInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationResource

public AuthenticationResource(AuthenticationController authenticationController)

Method Detail

authenticateUser

@POST
public javax.ws.rs.core.Response authenticateUser(@QueryParam(value="username")
                                                        String username,
                                                        PasswordEntity password)
                                                 throws ApplicationAccessDeniedException,
                                                        ExpiredCredentialException,
                                                        InactiveAccountException,
                                                        InvalidAuthenticationException,
                                                        OperationFailedException

Authenticates a user. Does not generate an SSO token. For SSO please take a look at the SSO token resource.

Parameters:

username - name of the user

Throws:

ApplicationAccessDeniedException

ExpiredCredentialException

InactiveAccountException

InvalidAuthenticationException

OperationFailedException

userAuthenticated

@ExperimentalApi
 @POST
 @Path(value="notify")
public javax.ws.rs.core.Response userAuthenticated(@QueryParam(value="username")
                                                                                                  String username)
                                                                                           throws InactiveAccountException,
                                                                                                  ExpiredCredentialException,
                                                                                                  OperationFailedException,
                                                                                                  InvalidAuthenticationException

Notifies Crowd that a user has logged into an application, using a method different than the default /authentication or /session resources. Does not initiate a SSO session.

This allows to trigger side effects in Crowd, such as updating the user from the remote directory, or applying automatic group assignments.

Parameters:

username - name of the user

Throws:

InactiveAccountException

ExpiredCredentialException

OperationFailedException

InvalidAuthenticationException

Since:

v3.3.0