Package com.w3asel.inventree.api
Class Authentication2FaApi
java.lang.Object
com.w3asel.inventree.api.Authentication2FaApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallauthAuth2faAuthenticatePost(AllauthMFAAuthenticate allauthMFAAuthenticate) Two-factor authentication If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.okhttp3.CallallauthAuth2faAuthenticatePostAsync(AllauthMFAAuthenticate allauthMFAAuthenticate, ApiCallback<AllauthAuthenticatedResponse> _callback) Two-factor authentication (asynchronously) If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.okhttp3.CallallauthAuth2faAuthenticatePostCall(AllauthMFAAuthenticate allauthMFAAuthenticate, ApiCallback _callback) Build call for allauthAuth2faAuthenticatePostallauthAuth2faAuthenticatePostWithHttpInfo(AllauthMFAAuthenticate allauthMFAAuthenticate) Two-factor authentication If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.Reauthenticate using 2FA In order to safeguard the account, some actions require the user to be recently authenticated.okhttp3.CallReauthenticate using 2FA (asynchronously) In order to safeguard the account, some actions require the user to be recently authenticated.okhttp3.CallallauthAuth2faReauthenticatePostCall(ApiCallback _callback) Build call for allauthAuth2faReauthenticatePostReauthenticate using 2FA In order to safeguard the account, some actions require the user to be recently authenticated.allauthAuth2faTrustPost(AllauthMFATrust allauthMFATrust) Trust this browser If \"Trust this browser?okhttp3.CallallauthAuth2faTrustPostAsync(AllauthMFATrust allauthMFATrust, ApiCallback<AllauthAuthenticatedResponse> _callback) Trust this browser (asynchronously) If \"Trust this browser?okhttp3.CallallauthAuth2faTrustPostCall(AllauthMFATrust allauthMFATrust, ApiCallback _callback) Build call for allauthAuth2faTrustPostallauthAuth2faTrustPostWithHttpInfo(AllauthMFATrust allauthMFATrust) Trust this browser If \"Trust this browser?intvoidsetApiClient(ApiClient apiClient) voidsetCustomBaseUrl(String customBaseUrl) voidsetHostIndex(int hostIndex)
-
Constructor Details
-
Authentication2FaApi
public Authentication2FaApi() -
Authentication2FaApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
getHostIndex
public int getHostIndex() -
setHostIndex
public void setHostIndex(int hostIndex) -
getCustomBaseUrl
-
setCustomBaseUrl
-
allauthAuth2faAuthenticatePostCall
public okhttp3.Call allauthAuth2faAuthenticatePostCall(@Nonnull AllauthMFAAuthenticate allauthMFAAuthenticate, ApiCallback _callback) throws ApiException Build call for allauthAuth2faAuthenticatePost- Parameters:
allauthMFAAuthenticate- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. - 401 Not authenticated. -
-
allauthAuth2faAuthenticatePost
public AllauthAuthenticatedResponse allauthAuth2faAuthenticatePost(@Nonnull AllauthMFAAuthenticate allauthMFAAuthenticate) throws ApiException Two-factor authentication If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.- Parameters:
allauthMFAAuthenticate- (required)- Returns:
- AllauthAuthenticatedResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. - 401 Not authenticated. -
-
allauthAuth2faAuthenticatePostWithHttpInfo
public ApiResponse<AllauthAuthenticatedResponse> allauthAuth2faAuthenticatePostWithHttpInfo(@Nonnull AllauthMFAAuthenticate allauthMFAAuthenticate) throws ApiException Two-factor authentication If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.- Parameters:
allauthMFAAuthenticate- (required)- Returns:
- ApiResponse<AllauthAuthenticatedResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. - 401 Not authenticated. -
-
allauthAuth2faAuthenticatePostAsync
public okhttp3.Call allauthAuth2faAuthenticatePostAsync(@Nonnull AllauthMFAAuthenticate allauthMFAAuthenticate, ApiCallback<AllauthAuthenticatedResponse> _callback) throws ApiException Two-factor authentication (asynchronously) If, during authentication, a response with status 401 is encountered where one of the pending flows has ID `mfa_authenticate`, that indicates that the Two-Factor Authentication stage needs to be completed.- Parameters:
allauthMFAAuthenticate- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. - 401 Not authenticated. -
-
allauthAuth2faReauthenticatePostCall
Build call for allauthAuth2faReauthenticatePost- Parameters:
_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faReauthenticatePost
Reauthenticate using 2FA In order to safeguard the account, some actions require the user to be recently authenticated. If you try to perform such an action without having been recently authenticated, a `401` status is returned, listing flows that can be performed to reauthenticate. One such flow is the flow with ID `mfa_reauthenticate`, which allows for the user to input an authenticator code (e.g. TOTP or recovery code). This is the endpoint related towards that flow.- Returns:
- AllauthAuthenticatedResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faReauthenticatePostWithHttpInfo
public ApiResponse<AllauthAuthenticatedResponse> allauthAuth2faReauthenticatePostWithHttpInfo() throws ApiExceptionReauthenticate using 2FA In order to safeguard the account, some actions require the user to be recently authenticated. If you try to perform such an action without having been recently authenticated, a `401` status is returned, listing flows that can be performed to reauthenticate. One such flow is the flow with ID `mfa_reauthenticate`, which allows for the user to input an authenticator code (e.g. TOTP or recovery code). This is the endpoint related towards that flow.- Returns:
- ApiResponse<AllauthAuthenticatedResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faReauthenticatePostAsync
public okhttp3.Call allauthAuth2faReauthenticatePostAsync(ApiCallback<AllauthAuthenticatedResponse> _callback) throws ApiException Reauthenticate using 2FA (asynchronously) In order to safeguard the account, some actions require the user to be recently authenticated. If you try to perform such an action without having been recently authenticated, a `401` status is returned, listing flows that can be performed to reauthenticate. One such flow is the flow with ID `mfa_reauthenticate`, which allows for the user to input an authenticator code (e.g. TOTP or recovery code). This is the endpoint related towards that flow.- Parameters:
_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faTrustPostCall
public okhttp3.Call allauthAuth2faTrustPostCall(@Nonnull AllauthMFATrust allauthMFATrust, ApiCallback _callback) throws ApiException Build call for allauthAuth2faTrustPost- Parameters:
allauthMFATrust- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faTrustPost
public AllauthAuthenticatedResponse allauthAuth2faTrustPost(@Nonnull AllauthMFATrust allauthMFATrust) throws ApiException Trust this browser If \"Trust this browser?\" is enabled (`MFA_TRUST_ENABLED`), the `mfa_trust` flow activates after the user completes the MFA authentication flow, offering to skip MFA for this particular browser. This endpoint is used to complete the `mfa_trust` flow.- Parameters:
allauthMFATrust- (required)- Returns:
- AllauthAuthenticatedResponse
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faTrustPostWithHttpInfo
public ApiResponse<AllauthAuthenticatedResponse> allauthAuth2faTrustPostWithHttpInfo(@Nonnull AllauthMFATrust allauthMFATrust) throws ApiException Trust this browser If \"Trust this browser?\" is enabled (`MFA_TRUST_ENABLED`), the `mfa_trust` flow activates after the user completes the MFA authentication flow, offering to skip MFA for this particular browser. This endpoint is used to complete the `mfa_trust` flow.- Parameters:
allauthMFATrust- (required)- Returns:
- ApiResponse<AllauthAuthenticatedResponse>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-
allauthAuth2faTrustPostAsync
public okhttp3.Call allauthAuth2faTrustPostAsync(@Nonnull AllauthMFATrust allauthMFATrust, ApiCallback<AllauthAuthenticatedResponse> _callback) throws ApiException Trust this browser (asynchronously) If \"Trust this browser?\" is enabled (`MFA_TRUST_ENABLED`), the `mfa_trust` flow activates after the user completes the MFA authentication flow, offering to skip MFA for this particular browser. This endpoint is used to complete the `mfa_trust` flow.- Parameters:
allauthMFATrust- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- HTTP Response Details:
Response Details Status Code Description Response Headers 200 Authenticated by password and 2FA. - 400 An input error occurred. -
-