Class AuthenticationApi.VerifyMfaCode

java.lang.Object

de.xima.fc.api.rest.pub.client.security.ApiCall<AuthenticationApi.VerifyMfaCode>

de.xima.fc.api.rest.pub.client.security.EndpointCategoryCall<AuthenticationApi.VerifyMfaCode>

de.xima.fc.api.rest.pub.client.security.api.AuthenticationApi.VerifyMfaCode

Enclosing class:

AuthenticationApi

public final class AuthenticationApi.VerifyMfaCode
extends EndpointCategoryCall<AuthenticationApi.VerifyMfaCode>

Handler for the verifyMfaCode API method that lets you choose the content type via the Accept header.

Field Summary

Fields inherited from class ApiCall

accept, apiCallInterceptor, authentications, authNames, body, cookieParams, headerParams, method, path, properties, queryParams, returnTypes

Method Summary

Modifier and Type	Method	Description
Class<? extends EndpointCategory>	endpointCategory()
ApiInvocation<MfaVerificationResponse>	requestJson()	Calls the API with the Accept header set to application/json; charset=utf-8.
ApiInvocation<MfaVerificationResponse>	requestJson_v1_0()	Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.
protected AuthenticationApi.VerifyMfaCode	self()
AuthenticationApi.VerifyMfaCode	withSave(Boolean save)	Sets the optional parameter save for the API call.

Methods inherited from class ApiCall

accept, accept, apiCallInterceptor, apiCallInterceptor, authentication, authentications, authentications, authNames, authNames, body, body, body, cookieParam, cookieParams, cookieParams, headerParam, headerParams, headerParams, method, method, path, path, properties, properties, property, queryParam, queryParams, queryParams, returnTypes, returnTypes

Methods inherited from class Object

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

Method Details

self

protected AuthenticationApi.VerifyMfaCode self()

Specified by:

self in class ApiCall<AuthenticationApi.VerifyMfaCode>

withSave

public AuthenticationApi.VerifyMfaCode withSave(Boolean save)

Sets the optional parameter save for the API call.

Parameters:

save - (optional, default to false)

Returns:

This handler for chaining method calls.

Throws:

IllegalArgumentException - When the parameter does not confirm to the expected format.

endpointCategory

public Class<? extends EndpointCategory> endpointCategory()

Specified by:

endpointCategory in class EndpointCategoryCall<AuthenticationApi.VerifyMfaCode>

Returns:

The endpoint category that created this API call.

requestJson

public ApiInvocation<MfaVerificationResponse> requestJson()

Calls the API with the Accept header set to application/json; charset=utf-8.

Verifies a multi-factor authentication (MFA) code. Verifies a multi-factor authentication (MFA) code in conjunction with an MFA token.

Status codes that may be returned by this API call:

• 200 - A successful response that might contain JWTs (access, refresh, id tokens)..

Returns:

A completion stage that resolves with the data returned by the API.

requestJson_v1_0

public ApiInvocation<MfaVerificationResponse> requestJson_v1_0()

Calls the API with the Accept header set to application/vnd.xima.fc.api.rest.public+json; version=1.0; charset=utf-8.

Verifies a multi-factor authentication (MFA) code. Verifies a multi-factor authentication (MFA) code in conjunction with an MFA token.

Status codes that may be returned by this API call:

• 200 - A successful response that might contain JWTs (access, refresh, id tokens)..

Returns:

A completion stage that resolves with the data returned by the API.