@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-07-14T17:07:26.321-05:00[America/Chicago]") public class UserFactorApi extends Object
Constructor and Description |
---|
UserFactorApi() |
UserFactorApi(ApiClient apiClient) |
Modifier and Type | Method and Description |
---|---|
UserFactor |
activateFactor(String userId,
String factorId,
ActivateFactorRequest body)
Activate a Factor
Activates a factor.
|
UserFactor |
activateFactor(String userId,
String factorId,
ActivateFactorRequest body,
Map<String,String> additionalHeaders)
Activate a Factor
Activates a 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
|
UserFactor |
enrollFactor(String userId,
UserFactor body,
Boolean updatePhone,
String templateId,
Integer tokenLifetimeSeconds,
Boolean activate,
Map<String,String> additionalHeaders)
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
|
UserFactor |
getFactor(String userId,
String factorId,
Map<String,String> additionalHeaders)
Retrieve a Factor
Retrieves a factor for the specified user
|
VerifyUserFactorResponse |
getFactorTransactionStatus(String userId,
String factorId,
String transactionId)
Retrieve a Factor Transaction Status
Retrieves the factors verification transaction status
|
VerifyUserFactorResponse |
getFactorTransactionStatus(String userId,
String factorId,
String transactionId,
Map<String,String> additionalHeaders)
Retrieve a Factor Transaction Status
Retrieves the factors verification transaction status
|
protected static com.fasterxml.jackson.databind.ObjectMapper |
getObjectMapper() |
List<UserFactor> |
listFactors(String userId)
List all Factors
Lists all the enrolled factors for the specified user
|
List<UserFactor> |
listFactors(String userId,
Map<String,String> additionalHeaders)
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
|
List<UserFactor> |
listSupportedFactors(String userId,
Map<String,String> additionalHeaders)
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
|
List<SecurityQuestion> |
listSupportedSecurityQuestions(String userId,
Map<String,String> additionalHeaders)
List all Supported Security Questions
Lists all available security questions for a user's `question` factor
|
UserFactor |
resendEnrollFactor(String userId,
String factorId,
UserFactor userFactor,
String templateId)
Resend a factor enrollment
Resends a factor challenge (SMS/call/email OTP) as part of an enrollment flow.
|
UserFactor |
resendEnrollFactor(String userId,
String factorId,
UserFactor userFactor,
String templateId,
Map<String,String> additionalHeaders)
Resend a factor enrollment
Resends a factor challenge (SMS/call/email OTP) as part of an enrollment flow.
|
void |
setApiClient(ApiClient apiClient) |
void |
unenrollFactor(String userId,
String factorId,
Boolean removeRecoveryEnrollment)
Unenroll a Factor
Unenrolls an existing factor for the specified user, allowing the user to enroll a new factor
|
void |
unenrollFactor(String userId,
String factorId,
Boolean removeRecoveryEnrollment,
Map<String,String> additionalHeaders)
Unenroll a Factor
Unenrolls an existing factor for the specified user, allowing the user to enroll a new 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
|
VerifyUserFactorResponse |
verifyFactor(String userId,
String factorId,
String templateId,
Integer tokenLifetimeSeconds,
String xForwardedFor,
String userAgent,
String acceptLanguage,
VerifyFactorRequest body,
Map<String,String> additionalHeaders)
Verify an MFA Factor
Verifies an OTP for a `token` or `token:hardware` factor
|
public UserFactorApi()
public UserFactorApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public UserFactor activateFactor(String userId, String factorId, ActivateFactorRequest body) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)body
- (optional)ApiException
- if fails to make API callpublic UserFactor activateFactor(String userId, String factorId, ActivateFactorRequest body, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)body
- (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic UserFactor enrollFactor(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate) throws ApiException
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)ApiException
- if fails to make API callpublic UserFactor enrollFactor(String userId, UserFactor body, Boolean updatePhone, String templateId, Integer tokenLifetimeSeconds, Boolean activate, Map<String,String> additionalHeaders) throws ApiException
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)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic UserFactor getFactor(String userId, String factorId) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)ApiException
- if fails to make API callpublic UserFactor getFactor(String userId, String factorId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic VerifyUserFactorResponse getFactorTransactionStatus(String userId, String factorId, String transactionId) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)transactionId
- `id` of the Transaction (required)ApiException
- if fails to make API callpublic VerifyUserFactorResponse getFactorTransactionStatus(String userId, String factorId, String transactionId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)transactionId
- `id` of the Transaction (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<UserFactor> listFactors(String userId) throws ApiException
userId
- (required)ApiException
- if fails to make API callpublic List<UserFactor> listFactors(String userId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<UserFactor> listSupportedFactors(String userId) throws ApiException
userId
- (required)ApiException
- if fails to make API callpublic List<UserFactor> listSupportedFactors(String userId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic List<SecurityQuestion> listSupportedSecurityQuestions(String userId) throws ApiException
userId
- (required)ApiException
- if fails to make API callpublic List<SecurityQuestion> listSupportedSecurityQuestions(String userId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic UserFactor resendEnrollFactor(String userId, String factorId, UserFactor userFactor, String templateId) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)userFactor
- Factor (required)templateId
- ID of SMS template (only for SMS factor) (optional)ApiException
- if fails to make API callpublic UserFactor resendEnrollFactor(String userId, String factorId, UserFactor userFactor, String templateId, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)userFactor
- Factor (required)templateId
- ID of SMS template (only for SMS factor) (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic void unenrollFactor(String userId, String factorId, Boolean removeRecoveryEnrollment) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)removeRecoveryEnrollment
- (optional, default to false)ApiException
- if fails to make API callpublic void unenrollFactor(String userId, String factorId, Boolean removeRecoveryEnrollment, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)removeRecoveryEnrollment
- (optional, default to false)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callpublic VerifyUserFactorResponse verifyFactor(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, VerifyFactorRequest body) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)templateId
- (optional)tokenLifetimeSeconds
- (optional, default to 300)xForwardedFor
- (optional)userAgent
- (optional)acceptLanguage
- (optional)body
- (optional)ApiException
- if fails to make API callpublic VerifyUserFactorResponse verifyFactor(String userId, String factorId, String templateId, Integer tokenLifetimeSeconds, String xForwardedFor, String userAgent, String acceptLanguage, VerifyFactorRequest body, Map<String,String> additionalHeaders) throws ApiException
userId
- (required)factorId
- `id` of the Factor (required)templateId
- (optional)tokenLifetimeSeconds
- (optional, default to 300)xForwardedFor
- (optional)userAgent
- (optional)acceptLanguage
- (optional)body
- (optional)additionalHeaders
- additionalHeaders for this callApiException
- if fails to make API callprotected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
Copyright © 2017–2023 Okta. All rights reserved.