io.stargate.auth.api.resources

Class AuthResource

java.lang.Object

io.stargate.auth.api.resources.AuthResource

@Path(value="/v1")
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @Singleton
public class AuthResource
extends Object

Constructor Summary

Constructors

Constructor and Description
AuthResource(AuthenticationService authService)
AuthResource(AuthenticationService authService, boolean shouldEnableUsernameToken)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createToken(Credentials credentials, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createToken(Secret secret, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createTokenFromUsername(UsernameCredentials usernameCredentials, javax.servlet.http.HttpServletRequest request) NOTE: This method is intended to be used in conjunction with another authentication service.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthResource

@Inject
public AuthResource(AuthenticationService authService)

AuthResource

public AuthResource(AuthenticationService authService,
                    boolean shouldEnableUsernameToken)

Method Detail

createToken

@POST
 @Path(value="/auth/token/generate")
public javax.ws.rs.core.Response createToken(Secret secret,
                                                                                        @Context
                                                                                        javax.servlet.http.HttpServletRequest request)

createToken

@POST
 @Path(value="/auth")
public javax.ws.rs.core.Response createToken(Credentials credentials,
                                                                         @Context
                                                                         javax.servlet.http.HttpServletRequest request)

createTokenFromUsername

@POST
 @Path(value="/admin/auth/usernametoken")
public javax.ws.rs.core.Response createTokenFromUsername(UsernameCredentials usernameCredentials,
                                                                                                         @Context
                                                                                                         javax.servlet.http.HttpServletRequest request)

NOTE: This method is intended to be used in conjunction with another authentication service. For example, the request has already been authenticated through a proxy but a token is still needed to make requests to Stargate.

Generates a token based solely on if the provided username exists in the database.

Parameters:

usernameCredentials - A username to generate a token for IFF the username exists in the database.

Returns:

On success will return a token to be used with later requests to Stargate.