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

Class TokenResource

java.lang.Object

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

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

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

Crowd SSO Token Resource.

Field Summary

Fields

Modifier and Type	Field and Description
static IntegerSystemProperty	TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY Set a system property with this name to define the max-age of the 'Cache-Control' header in the response of the token validation and get user operations on this resource.

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

request, uriInfo

Constructor Summary

Constructors

Constructor and Description
TokenResource(TokenController tokenController)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	authenticateUser(AuthenticationContextEntity authenticationContext, boolean validatePassword, long durationInSeconds) Create new session token valid for duration seconds, or for the server default session timeout if no duration is specified or if duration is longer than the server default session timeout.
javax.ws.rs.core.Response	deleteTokensForUser(String username, String exclusionToken) Invalidate all tokens for a given user name.
javax.ws.rs.core.Response	getSession(String token) Retrieves the token with the authenticated user expanded.
javax.ws.rs.core.Response	invalidateToken(String token) Invalidates the Crowd SSO token.
javax.ws.rs.core.Response	validateToken(String token, ValidationFactorEntityList validationFactors) Validates the session token.

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

Field Detail

TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY

public static final IntegerSystemProperty TOKEN_CACHE_CONTROL_MAX_AGE_SYSTEM_PROPERTY

Set a system property with this name to define the max-age of the 'Cache-Control' header in the response of the token validation and get user operations on this resource. The default value (negative) means that the 'Cache-Control' header will not be sent, which was the previous behaviour until this system property was added.

Constructor Detail

TokenResource

public TokenResource(TokenController tokenController)

Method Detail

authenticateUser

@POST
public javax.ws.rs.core.Response authenticateUser(AuthenticationContextEntity authenticationContext,
                                                        @DefaultValue(value="true") @QueryParam(value="validate-password")
                                                        boolean validatePassword,
                                                        @DefaultValue(value="-1") @QueryParam(value="duration")
                                                        long durationInSeconds)
                                                 throws InvalidAuthenticationException,
                                                        InactiveAccountException,
                                                        ExpiredCredentialException,
                                                        ApplicationAccessDeniedException,
                                                        OperationFailedException

Create new session token valid for duration seconds, or for the server default session timeout if no duration is specified or if duration is longer than the server default session timeout.

Either the user password needs to be valid or the validate-password query param must be set to false.

If an ongoing session already exists for the same authentication credentials and validation factors, then that session token is returned.

Parameters:

authenticationContext - authentication information

validatePassword - true if the password should be validated (optional, defaults to true)

durationInSeconds - requested duration of the token, in seconds (optional, defaults to server session duration)

Returns:

status 201 with Crowd SSO token if successful

Throws:

InvalidAuthenticationException

InactiveAccountException

ExpiredCredentialException

ApplicationAccessDeniedException

OperationFailedException

invalidateToken

@DELETE
 @Path(value="{token}")
public javax.ws.rs.core.Response invalidateToken(@PathParam(value="token")
                                                                                 String token)

Invalidates the Crowd SSO token.

Parameters:

token - the token to invalidate

validateToken

@POST
 @Path(value="{token}")
public javax.ws.rs.core.Response validateToken(@PathParam(value="token")
                                                                             String token,
                                                                             ValidationFactorEntityList validationFactors)
                                                                      throws InvalidTokenException,
                                                                             ApplicationAccessDeniedException,
                                                                             OperationFailedException

Validates the session token. Validating the token keeps the SSO session alive.

Parameters:

token - Crowd SSO token

validationFactors - list of validation factors

Throws:

InvalidTokenException

ApplicationAccessDeniedException

OperationFailedException

getSession

@GET
 @Path(value="{token}")
public javax.ws.rs.core.Response getSession(@PathParam(value="token")
                                                                         String token)
                                                                  throws InvalidTokenException,
                                                                         OperationFailedException,
                                                                         ApplicationAccessDeniedException

Retrieves the token with the authenticated user expanded.

Parameters:

token - the token to retrieve

Throws:

InvalidTokenException

OperationFailedException

ApplicationAccessDeniedException

deleteTokensForUser

@DELETE
public javax.ws.rs.core.Response deleteTokensForUser(@QueryParam(value="username")
                                                             String username,
                                                             @QueryParam(value="exclude")
                                                             String exclusionToken)

Invalidate all tokens for a given user name.

Optionally, a token key can be saved from invalidation if specified in the exclude param

Parameters:

username - The user for which the tokens will be invalidated

exclusionToken - The token to exclude