Package de.xima.fc.api.rest.pub.impl.security.services

Class AuthenticationService

java.lang.Object

de.xima.fc.api.rest.pub.impl.security.services.AuthenticationService

@Path("/security/auth")
public class AuthenticationService
extends Object

Service that provides authentication endpoints

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
AuthenticationService()

Method Summary

Modifier and Type	Method	Description
AuthenticationResponse	authenticate(@NotBlank String clientName, @NotBlank String userName, @NotBlank String password)
MfaSettingsResponse	getMfaSettings()
javax.ws.rs.core.Response	refresh(@NotBlank String clientName, @NotBlank String refreshToken)
MfaTempTokenResponse	refreshMfaTempToken(@NotBlank String token)
javax.ws.rs.core.Response	revoke(@NotBlank String clientName, @NotBlank String refreshToken)
MfaVerificationResponse	verifyMfaCode(@NotBlank String mfaCode, @NotBlank String mfaTempToken, boolean saveMfa)

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthenticationService

public AuthenticationService()

Method Detail

authenticate

@POST
@Path("/{clientName}/token")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("application/x-www-form-urlencoded")
public AuthenticationResponse authenticate(@NotBlank @PathParam("clientName")
                                           @NotBlank String clientName,
                                           @FormParam("username") @NotBlank
                                           @NotBlank String userName,
                                           @FormParam("password") @NotBlank
                                           @NotBlank String password)

getMfaSettings

@GET
@Path("/mfa/settings")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
public MfaSettingsResponse getMfaSettings()

refresh

@POST
@Path("/{clientName}/token/refresh")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("application/x-www-form-urlencoded")
public javax.ws.rs.core.Response refresh(@NotBlank @PathParam("clientName")
                                         @NotBlank String clientName,
                                         @FormParam("refresh_token") @NotBlank
                                         @NotBlank String refreshToken)

refreshMfaTempToken

@POST
@Path("/mfa/refresh/{token}")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("application/x-www-form-urlencoded")
public MfaTempTokenResponse refreshMfaTempToken(@NotBlank @PathParam("token")
                                                @NotBlank String token)

revoke

@POST
@Path("/{clientName}/token/revoke")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("application/x-www-form-urlencoded")
public javax.ws.rs.core.Response revoke(@NotBlank @PathParam("clientName")
                                        @NotBlank String clientName,
                                        @FormParam("refresh_token") @NotBlank
                                        @NotBlank String refreshToken)

verifyMfaCode

@POST
@Path("/mfa/verify")
@Produces({"application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8","application/json; charset=utf-8"})
@Consumes("application/x-www-form-urlencoded")
public MfaVerificationResponse verifyMfaCode(@FormParam("code") @NotBlank
                                             @NotBlank String mfaCode,
                                             @FormParam("token") @NotBlank
                                             @NotBlank String mfaTempToken,
                                             @FormParam("save") @DefaultValue("false")
                                             boolean saveMfa)