Package org.apache.syncope.common.rest.api.service

Interface MfaService

All Superinterfaces:

JAXRSService

@Path("mfa")
public interface MfaService
extends JAXRSService

REST operations for MFA management.

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	check(org.apache.syncope.common.lib.types.MfaCheck mfaCheck)	Check the provided OTP against the provided MFA secret.
void	dismiss()	Dismiss MFA information for the calling user.
void	dismiss(@NotNull String username)	Dismiss MFA information for the given user.
void	enroll(org.apache.syncope.common.lib.types.Mfa mfa)	Store the provided MFA information for the calling user.
jakarta.ws.rs.core.Response	enrolled(@NotNull String username)	Checks if MFA information was enrolled for the given user.
org.apache.syncope.common.lib.types.Mfa	generate(@NotNull String username)	Generate MFA information for the given user.

Method Details

generate

@POST
@Path("{username}")
@Produces("application/json")
org.apache.syncope.common.lib.types.Mfa generate(@NotNull @PathParam("username")
 @NotNull String username)

Generate MFA information for the given user.

Parameters:

username - username

Returns:

MFA information for the given user.

enroll

@PUT
@Consumes("application/json")
void enroll(org.apache.syncope.common.lib.types.Mfa mfa)

Store the provided MFA information for the calling user.

Parameters:

mfa - MFA information

dismiss

@DELETE
void dismiss()

Dismiss MFA information for the calling user.

dismiss

@DELETE
@Path("{username}")
void dismiss(@NotNull @PathParam("username")
 @NotNull String username)

Dismiss MFA information for the given user.

Parameters:

username - username

enrolled

@HEAD
@Path("{username}")
jakarta.ws.rs.core.Response enrolled(@NotNull @PathParam("username")
 @NotNull String username)

Checks if MFA information was enrolled for the given user.

Parameters:

username - username

Returns:

Response object featuring the boolean result in the 'X-Syncope-Verfied' header

check

@POST
@Path("check")
@Consumes("application/json")
jakarta.ws.rs.core.Response check(org.apache.syncope.common.lib.types.MfaCheck mfaCheck)

Check the provided OTP against the provided MFA secret.

Parameters:

mfaCheck - MFA secret and OTP

Returns:

Response object featuring the boolean result in the 'X-Syncope-Verfied' header