Package org.apache.fineract.client.services

Interface TwoFactorApi

public interface TwoFactorApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	getOTPDeliveryMethods()
retrofit2.Call<String>	getOTPDeliveryMethods(Map<String,String> headers)
retrofit2.Call<String>	requestToken(String deliveryMethod, Boolean extendedToken)
retrofit2.Call<String>	requestToken(String deliveryMethod, Boolean extendedToken, Map<String,String> headers)
retrofit2.Call<String>	updateConfiguration2()
retrofit2.Call<String>	updateConfiguration2(String body)
retrofit2.Call<String>	updateConfiguration2(String body, Map<String,String> headers)
retrofit2.Call<String>	updateConfiguration2(Map<String,String> headers)
retrofit2.Call<String>	validate(String token)
retrofit2.Call<String>	validate(String token, Map<String,String> headers)

Method Details

getOTPDeliveryMethods

@GET("v1/twofactor")
retrofit2.Call<String> getOTPDeliveryMethods()

Returns:

Call<String>

requestToken

@POST("v1/twofactor")
retrofit2.Call<String> requestToken(@Query("deliveryMethod")
 String deliveryMethod,
 @Query("extendedToken")
 Boolean extendedToken)

Parameters:

deliveryMethod - (optional)

extendedToken - (optional, default to false)

Returns:

Call<String>

updateConfiguration2

@POST("v1/twofactor/invalidate")
retrofit2.Call<String> updateConfiguration2(@Body
 String body)

Parameters:

body - (optional)

Returns:

Call<String>

validate

@POST("v1/twofactor/validate")
retrofit2.Call<String> validate(@Query("token")
 String token)

Parameters:

token - (optional)

Returns:

Call<String>

updateConfiguration2

@POST("v1/twofactor/invalidate")
retrofit2.Call<String> updateConfiguration2()

Parameters:

body - (optional)

Returns:

Call<String>

getOTPDeliveryMethods

@GET("v1/twofactor")
retrofit2.Call<String> getOTPDeliveryMethods(@HeaderMap
 Map<String,String> headers)

Returns:

Call<String>

requestToken

@POST("v1/twofactor")
retrofit2.Call<String> requestToken(@Query("deliveryMethod")
 String deliveryMethod,
 @Query("extendedToken")
 Boolean extendedToken,
 @HeaderMap
 Map<String,String> headers)

Parameters:

deliveryMethod - (optional)

extendedToken - (optional, default to false)

Returns:

Call<String>

updateConfiguration2

@POST("v1/twofactor/invalidate")
retrofit2.Call<String> updateConfiguration2(@Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

body - (optional)

Returns:

Call<String>

validate

@POST("v1/twofactor/validate")
retrofit2.Call<String> validate(@Query("token")
 String token,
 @HeaderMap
 Map<String,String> headers)

Parameters:

token - (optional)

Returns:

Call<String>

updateConfiguration2

@POST("v1/twofactor/invalidate")
retrofit2.Call<String> updateConfiguration2(@HeaderMap
 Map<String,String> headers)

Parameters:

body - (optional)

Returns:

Call<String>