de.alpharogroup.user.management.rest.api

Interface AuthenticationsResource

All Known Implementing Classes:

AuthenticationsRestResource

@Path(value="/auth/")
 @Produces(value="application/json")
 @Consumes(value="application/json")
public interface AuthenticationsResource

The interface AuthenticationsResource provides methods for authenticate users of a given application.

Method Summary

Modifier and Type	Method and Description
Response	authenticate(de.alpharogroup.auth.Credentials credentials) Authenticate a user with the given Credentials.
Response	authenticate(String username, String password) Authenticate a user with the given email or username and the given password.

Method Detail

authenticate

@POST
 @Path(value="/credentials")
Response authenticate(de.alpharogroup.auth.Credentials credentials)

Authenticate a user with the given Credentials.

Parameters:

credentials - the credentials

Returns:

the response

authenticate

@POST
 @Path(value="/form")
 @Produces(value="application/json")
 @Consumes(value="application/x-www-form-urlencoded")
Response authenticate(@FormParam(value="username")
                                                                                                                                             String username,
                                                                                                                                             @FormParam(value="password")
                                                                                                                                             String password)

Authenticate a user with the given email or username and the given password.

Parameters:

username - the email or username

password - the password

Returns:

the Response object