org.openapitools.client.api

Class UserFactorApi

java.lang.Object

org.openapitools.client.api.UserFactorApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.UserFactorApi")
public class UserFactorApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UserFactorApi()
UserFactorApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	activateFactor(Class<?> T, String userId, String factorId, ActivateFactorRequest body) Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process
UserFactor	activateFactor(String userId, String factorId, ActivateFactorRequest body) Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process
PagedList	activateFactorWithPaginationInfo(String userId, String factorId, ActivateFactorRequest body) Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process
void	deleteFactor(String userId, String factorId, Boolean removeEnrollmentRecovery) Delete a Factor Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor
<T> T	enrollFactor(Class<?> T, String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate) Enroll a Factor Enrolls a user with a supported factor
UserFactor	enrollFactor(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate) Enroll a Factor Enrolls a user with a supported factor
PagedList	enrollFactorWithPaginationInfo(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate) Enroll a Factor Enrolls a user with a supported factor
ApiClient	getApiClient()
UserFactor	getFactor(String userId, String factorId) Retrieve a Factor Retrieves a factor for the specified user
VerifyUserFactorResponse	getFactorTransactionStatus(String userId, String factorId, String transactionId) Retrieve a Factor Transaction Status Polls factors verification transaction for status
PagedList	getFactorTransactionStatusWithPaginationInfo(String userId, String factorId, String transactionId) Retrieve a Factor Transaction Status Polls factors verification transaction for status
PagedList	getFactorWithPaginationInfo(String userId, String factorId) Retrieve a Factor Retrieves a factor for the specified user
List<UserFactor>	listFactors(String userId) List all Factors Lists all the enrolled factors for the specified user
PagedList	listFactorsWithPaginationInfo(String userId) List all Factors Lists all the enrolled factors for the specified user
List<UserFactor>	listSupportedFactors(String userId) List all Supported Factors Lists all the supported factors that can be enrolled for the specified user
PagedList	listSupportedFactorsWithPaginationInfo(String userId) List all Supported Factors Lists all the supported factors that can be enrolled for the specified user
List<SecurityQuestion>	listSupportedSecurityQuestions(String userId) List all Supported Security Questions Lists all available security questions for a user's `question` factor
PagedList	listSupportedSecurityQuestionsWithPaginationInfo(String userId) List all Supported Security Questions Lists all available security questions for a user's `question` factor
void	setApiClient(ApiClient apiClient)
<T> T	verifyFactor(Class<?> T, String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, VerifyFactorRequest body) Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
VerifyUserFactorResponse	verifyFactor(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, VerifyFactorRequest body) Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor
PagedList	verifyFactorWithPaginationInfo(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, VerifyFactorRequest body) Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

Methods inherited from class java.lang.Object

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

Constructor Detail

UserFactorApi

public UserFactorApi()

UserFactorApi

@Autowired
public UserFactorApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateFactor

public UserFactor activateFactor(String userId,
                                 String factorId,
                                 ActivateFactorRequest body)
                          throws org.springframework.web.client.RestClientException

Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

body - (optional)

Returns:

UserFactor

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateFactor

public <T> T activateFactor(Class<?> T,
                            String userId,
                            String factorId,
                            ActivateFactorRequest body)
                     throws org.springframework.web.client.RestClientException

Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

factorId - (required)

body - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateFactorWithPaginationInfo

public PagedList activateFactorWithPaginationInfo(String userId,
                                                  String factorId,
                                                  ActivateFactorRequest body)
                                           throws org.springframework.web.client.RestClientException

Activate a Factor The `sms` and `token:software:totp` factor types require activation to complete the enrollment process

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

body - (optional)

Returns:

ResponseEntity<UserFactor>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteFactor

public void deleteFactor(String userId,
                         String factorId,
                         Boolean removeEnrollmentRecovery)
                  throws org.springframework.web.client.RestClientException

Delete a Factor Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

removeEnrollmentRecovery - (optional, default to false)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

enrollFactor

public UserFactor enrollFactor(String userId,
                               UserFactor body,
                               Boolean updatePhone,
                               String templateId,
                               Integer tokenLifetimeSeconds,
                               Boolean activate)
                        throws org.springframework.web.client.RestClientException

Enroll a Factor Enrolls a user with a supported factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

body - Factor (required)

updatePhone - (optional, default to false)

templateId - id of SMS template (only for SMS factor) (optional)

tokenLifetimeSeconds - (optional, default to 300)

activate - (optional, default to false)

Returns:

UserFactor

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

enrollFactor

public <T> T enrollFactor(Class<?> T,
                          String userId,
                          UserFactor body,
                          Boolean updatePhone,
                          String templateId,
                          Integer tokenLifetimeSeconds,
                          Boolean activate)
                   throws org.springframework.web.client.RestClientException

Enroll a Factor Enrolls a user with a supported factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

body - Factor (required)

updatePhone - (optional, default to false)

templateId - id of SMS template (only for SMS factor) (optional)

tokenLifetimeSeconds - (optional, default to 300)

activate - (optional, default to false)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

enrollFactorWithPaginationInfo

public PagedList enrollFactorWithPaginationInfo(String userId,
                                                UserFactor body,
                                                Boolean updatePhone,
                                                String templateId,
                                                Integer tokenLifetimeSeconds,
                                                Boolean activate)
                                         throws org.springframework.web.client.RestClientException

Enroll a Factor Enrolls a user with a supported factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

body - Factor (required)

updatePhone - (optional, default to false)

templateId - id of SMS template (only for SMS factor) (optional)

tokenLifetimeSeconds - (optional, default to 300)

activate - (optional, default to false)

Returns:

ResponseEntity<UserFactor>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getFactor

public UserFactor getFactor(String userId,
                            String factorId)
                     throws org.springframework.web.client.RestClientException

Retrieve a Factor Retrieves a factor for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

Returns:

UserFactor

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getFactorWithPaginationInfo

public PagedList getFactorWithPaginationInfo(String userId,
                                             String factorId)
                                      throws org.springframework.web.client.RestClientException

Retrieve a Factor Retrieves a factor for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

Returns:

ResponseEntity<UserFactor>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getFactorTransactionStatus

public VerifyUserFactorResponse getFactorTransactionStatus(String userId,
                                                           String factorId,
                                                           String transactionId)
                                                    throws org.springframework.web.client.RestClientException

Retrieve a Factor Transaction Status Polls factors verification transaction for status

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

transactionId - (required)

Returns:

VerifyUserFactorResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getFactorTransactionStatusWithPaginationInfo

public PagedList getFactorTransactionStatusWithPaginationInfo(String userId,
                                                              String factorId,
                                                              String transactionId)
                                                       throws org.springframework.web.client.RestClientException

Retrieve a Factor Transaction Status Polls factors verification transaction for status

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

transactionId - (required)

Returns:

ResponseEntity<VerifyUserFactorResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listFactors

public List<UserFactor> listFactors(String userId)
                             throws org.springframework.web.client.RestClientException

List all Factors Lists all the enrolled factors for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<UserFactor>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listFactorsWithPaginationInfo

public PagedList listFactorsWithPaginationInfo(String userId)
                                        throws org.springframework.web.client.RestClientException

List all Factors Lists all the enrolled factors for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<UserFactor>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSupportedFactors

public List<UserFactor> listSupportedFactors(String userId)
                                      throws org.springframework.web.client.RestClientException

List all Supported Factors Lists all the supported factors that can be enrolled for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<UserFactor>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSupportedFactorsWithPaginationInfo

public PagedList listSupportedFactorsWithPaginationInfo(String userId)
                                                 throws org.springframework.web.client.RestClientException

List all Supported Factors Lists all the supported factors that can be enrolled for the specified user

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<UserFactor>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSupportedSecurityQuestions

public List<SecurityQuestion> listSupportedSecurityQuestions(String userId)
                                                      throws org.springframework.web.client.RestClientException

List all Supported Security Questions Lists all available security questions for a user's `question` factor

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

List<SecurityQuestion>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listSupportedSecurityQuestionsWithPaginationInfo

public PagedList listSupportedSecurityQuestionsWithPaginationInfo(String userId)
                                                           throws org.springframework.web.client.RestClientException

List all Supported Security Questions Lists all available security questions for a user's `question` factor

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

Returns:

ResponseEntity<List<SecurityQuestion>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

verifyFactor

public VerifyUserFactorResponse verifyFactor(String userId,
                                             String factorId,
                                             String templateId,
                                             Integer tokenLifetimeSeconds,
                                             String xForwardedFor,
                                             String userAgent,
                                             String acceptLanguage,
                                             VerifyFactorRequest body)
                                      throws org.springframework.web.client.RestClientException

Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

templateId - (optional)

tokenLifetimeSeconds - (optional, default to 300)

xForwardedFor - (optional)

userAgent - (optional)

acceptLanguage - (optional)

body - (optional)

Returns:

VerifyUserFactorResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

verifyFactor

public <T> T verifyFactor(Class<?> T,
                          String userId,
                          String factorId,
                          String templateId,
                          Integer tokenLifetimeSeconds,
                          String xForwardedFor,
                          String userAgent,
                          String acceptLanguage,
                          VerifyFactorRequest body)
                   throws org.springframework.web.client.RestClientException

Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

factorId - (required)

templateId - (optional)

tokenLifetimeSeconds - (optional, default to 300)

xForwardedFor - (optional)

userAgent - (optional)

acceptLanguage - (optional)

body - (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

verifyFactorWithPaginationInfo

public PagedList verifyFactorWithPaginationInfo(String userId,
                                                String factorId,
                                                String templateId,
                                                Integer tokenLifetimeSeconds,
                                                String xForwardedFor,
                                                String userAgent,
                                                String acceptLanguage,
                                                VerifyFactorRequest body)
                                         throws org.springframework.web.client.RestClientException

Verify an MFA Factor Verifies an OTP for a `token` or `token:hardware` factor

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

factorId - (required)

templateId - (optional)

tokenLifetimeSeconds - (optional, default to 300)

xForwardedFor - (optional)

userAgent - (optional)

acceptLanguage - (optional)

body - (optional)

Returns:

ResponseEntity<VerifyUserFactorResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API