com.okta.sdk.helper

Class UserFactorApiHelper<T extends UserFactor>

java.lang.Object

org.openapitools.client.api.UserFactorApi

com.okta.sdk.helper.UserFactorApiHelper<T>

public class UserFactorApiHelper<T extends UserFactor>
extends UserFactorApi

Helper class that enables working with sub-typed UserFactor references.

Constructor Summary

Constructors

Constructor and Description
UserFactorApiHelper(ApiClient apiClient)
UserFactorApiHelper(UserFactorApi userFactorApi)

Method Summary

Modifier and Type	Method and Description
<T extends UserFactor> T	activateFactorOfType(Class<T> classType, String userId, String factorId, ActivateFactorRequest activateFactorRequest)
<T extends UserFactor> T	enrollFactorOfType(Class<T> classType, String userId, UserFactor userFactor, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate)
T	getFactor(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
List<UserFactor>	listSupportedFactors(String userId) List all Supported Factors Lists all the supported factors that can be enrolled for the specified user
<T extends UserFactor> T	resendEnrollFactorOfType(Class<T> classType, String userId, String factorId, UserFactor userFactor, String templateId)

Methods inherited from class org.openapitools.client.api.UserFactorApi

activateFactor, activateFactor, enrollFactor, enrollFactor, getApiClient, getFactor, getFactorTransactionStatus, getFactorTransactionStatus, getObjectMapper, listFactors, listSupportedFactors, listSupportedSecurityQuestions, listSupportedSecurityQuestions, resendEnrollFactor, resendEnrollFactor, setApiClient, unenrollFactor, unenrollFactor, verifyFactor, verifyFactor

Methods inherited from class java.lang.Object

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

Constructor Detail

UserFactorApiHelper

public UserFactorApiHelper(UserFactorApi userFactorApi)

UserFactorApiHelper

public UserFactorApiHelper(ApiClient apiClient)

Method Detail

activateFactorOfType

public <T extends UserFactor> T activateFactorOfType(Class<T> classType,
                                                     String userId,
                                                     String factorId,
                                                     ActivateFactorRequest activateFactorRequest)
                                              throws ApiException

Throws:

ApiException

enrollFactorOfType

public <T extends UserFactor> T enrollFactorOfType(Class<T> classType,
                                                   String userId,
                                                   UserFactor userFactor,
                                                   Boolean updatePhone,
                                                   String templateId,
                                                   Integer tokenLifetimeSeconds,
                                                   Boolean activate)
                                            throws ApiException

Throws:

ApiException

getFactor

public T getFactor(String userId,
                   String factorId)
            throws ApiException

Description copied from class: UserFactorApi

Retrieve a Factor Retrieves a factor for the specified user

Overrides:

getFactor in class UserFactorApi

Parameters:

userId - (required)

factorId - `id` of the Factor (required)

Returns:

UserFactor

Throws:

ApiException - if fails to make API call

listFactors

public List<UserFactor> listFactors(String userId)
                             throws ApiException

Description copied from class: UserFactorApi

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

Overrides:

listFactors in class UserFactorApi

Parameters:

userId - (required)

Returns:

List<UserFactor>

Throws:

ApiException - if fails to make API call

listSupportedFactors

public List<UserFactor> listSupportedFactors(String userId)
                                      throws ApiException

Description copied from class: UserFactorApi

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

Overrides:

listSupportedFactors in class UserFactorApi

Parameters:

userId - (required)

Returns:

List<UserFactor>

Throws:

ApiException - if fails to make API call

resendEnrollFactorOfType

public <T extends UserFactor> T resendEnrollFactorOfType(Class<T> classType,
                                                         String userId,
                                                         String factorId,
                                                         UserFactor userFactor,
                                                         String templateId)
                                                  throws ApiException

Throws:

ApiException