Package org.apache.fineract.client.services

Interface AuthenticationHttpBasicApi

public interface AuthenticationHttpBasicApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<PostAuthenticationResponse>	authenticate(PostAuthenticationRequest postAuthenticationRequest, Boolean returnClientList)	Verify authentication Authenticates the credentials provided and returns the set roles and permissions allowed.
retrofit2.Call<PostAuthenticationResponse>	authenticate(PostAuthenticationRequest postAuthenticationRequest, Boolean returnClientList, Map<String,String> headers)	Verify authentication Authenticates the credentials provided and returns the set roles and permissions allowed.

Method Details

authenticate

@Headers("Content-Type:application/json")
@POST("v1/authentication")
retrofit2.Call<PostAuthenticationResponse> authenticate(@Body
 PostAuthenticationRequest postAuthenticationRequest,
 @Query("returnClientList")
 Boolean returnClientList)

Verify authentication Authenticates the credentials provided and returns the set roles and permissions allowed.

Parameters:

postAuthenticationRequest - (required)

returnClientList - (optional, default to false)

Returns:

Call<PostAuthenticationResponse>

authenticate

@Headers("Content-Type:application/json")
@POST("v1/authentication")
retrofit2.Call<PostAuthenticationResponse> authenticate(@Body
 PostAuthenticationRequest postAuthenticationRequest,
 @Query("returnClientList")
 Boolean returnClientList,
 @HeaderMap
 Map<String,String> headers)

Verify authentication Authenticates the credentials provided and returns the set roles and permissions allowed.

Parameters:

postAuthenticationRequest - (required)

returnClientList - (optional, default to false)

Returns:

Call<PostAuthenticationResponse>