Package com.oracle.bmc.identitydomains.model

Class AuthenticationFactorSettingsTotpSettings

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.identitydomains.model.AuthenticationFactorSettingsTotpSettings

@Generated(value="OracleSDKGenerator",
           comments="API Version: v1")
public final class AuthenticationFactorSettingsTotpSettings
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Settings related to Time-Based One-Time Passcodes (TOTP), such as hashing algo, totp time step, passcode length, and so on

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: complex - uniqueness: none
Note: Objects should always be created or deserialized using the AuthenticationFactorSettingsTotpSettings.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AuthenticationFactorSettingsTotpSettings.Builder, which maintain a set of all explicitly set fields called AuthenticationFactorSettingsTotpSettings.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuthenticationFactorSettingsTotpSettings.Builder
static class	AuthenticationFactorSettingsTotpSettings.HashingAlgorithm	The hashing algorithm to be used to calculate a One-Time Passcode.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AuthenticationFactorSettingsTotpSettings(AuthenticationFactorSettingsTotpSettings.HashingAlgorithm hashingAlgorithm, Integer passcodeLength, Integer keyRefreshIntervalInDays, Integer timeStepInSecs, Integer timeStepTolerance, Integer smsOtpValidityDurationInMins, Integer jwtValidityDurationInSecs, Integer smsPasscodeLength, Integer emailOtpValidityDurationInMins, Integer emailPasscodeLength)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static AuthenticationFactorSettingsTotpSettings.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getEmailOtpValidityDurationInMins()	The period of time (in minutes) that a one-time passcode remains valid that the system sends by email.
Integer	getEmailPasscodeLength()	Exact length of the email one-time passcode.
AuthenticationFactorSettingsTotpSettings.HashingAlgorithm	getHashingAlgorithm()	The hashing algorithm to be used to calculate a One-Time Passcode.
Integer	getJwtValidityDurationInSecs()	The period of time (in seconds) that a JSON Web Token (JWT) is valid
Integer	getKeyRefreshIntervalInDays()	The duration of time (in days) after which the shared secret has to be refreshed
Integer	getPasscodeLength()	Exact length of the One-Time Passcode that the system should generate
Integer	getSmsOtpValidityDurationInMins()	The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid
Integer	getSmsPasscodeLength()	Exact length of the Short Message Service (SMS) One-Time Passcode
Integer	getTimeStepInSecs()	Time (in secs) to be used as the time step
Integer	getTimeStepTolerance()	The tolerance/step-size that the system should use when validating a One-Time Passcode
int	hashCode()
AuthenticationFactorSettingsTotpSettings.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthenticationFactorSettingsTotpSettings

@Deprecated
@ConstructorProperties({"hashingAlgorithm","passcodeLength","keyRefreshIntervalInDays","timeStepInSecs","timeStepTolerance","smsOtpValidityDurationInMins","jwtValidityDurationInSecs","smsPasscodeLength","emailOtpValidityDurationInMins","emailPasscodeLength"})
public AuthenticationFactorSettingsTotpSettings(AuthenticationFactorSettingsTotpSettings.HashingAlgorithm hashingAlgorithm,
                                                Integer passcodeLength,
                                                Integer keyRefreshIntervalInDays,
                                                Integer timeStepInSecs,
                                                Integer timeStepTolerance,
                                                Integer smsOtpValidityDurationInMins,
                                                Integer jwtValidityDurationInSecs,
                                                Integer smsPasscodeLength,
                                                Integer emailOtpValidityDurationInMins,
                                                Integer emailPasscodeLength)

Deprecated.

Method Detail

builder

public static AuthenticationFactorSettingsTotpSettings.Builder builder()

Create a new builder.

toBuilder

public AuthenticationFactorSettingsTotpSettings.Builder toBuilder()

getHashingAlgorithm

public AuthenticationFactorSettingsTotpSettings.HashingAlgorithm getHashingAlgorithm()

The hashing algorithm to be used to calculate a One-Time Passcode.

By default, the system uses SHA1.

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

the value

getPasscodeLength

public Integer getPasscodeLength()

Exact length of the One-Time Passcode that the system should generate

*SCIM++ Properties:** - idcsMaxValue: 10 - idcsMinValue: 4 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getKeyRefreshIntervalInDays

public Integer getKeyRefreshIntervalInDays()

The duration of time (in days) after which the shared secret has to be refreshed

*SCIM++ Properties:** - idcsMaxValue: 999 - idcsMinValue: 30 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getTimeStepInSecs

public Integer getTimeStepInSecs()

Time (in secs) to be used as the time step

*SCIM++ Properties:** - idcsMaxValue: 300 - idcsMinValue: 30 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getTimeStepTolerance

public Integer getTimeStepTolerance()

The tolerance/step-size that the system should use when validating a One-Time Passcode

*SCIM++ Properties:** - idcsMaxValue: 3 - idcsMinValue: 2 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getSmsOtpValidityDurationInMins

public Integer getSmsOtpValidityDurationInMins()

The period of time (in minutes) for which a One-Time Passcode that the system sends by Short Message Service (SMS) or by voice remains valid

*SCIM++ Properties:** - idcsMaxValue: 60 - idcsMinValue: 2 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getJwtValidityDurationInSecs

public Integer getJwtValidityDurationInSecs()

The period of time (in seconds) that a JSON Web Token (JWT) is valid

*SCIM++ Properties:** - idcsMaxValue: 99999 - idcsMinValue: 30 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getSmsPasscodeLength

public Integer getSmsPasscodeLength()

Exact length of the Short Message Service (SMS) One-Time Passcode

*SCIM++ Properties:** - idcsMaxValue: 10 - idcsMinValue: 4 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getEmailOtpValidityDurationInMins

public Integer getEmailOtpValidityDurationInMins()

The period of time (in minutes) that a one-time passcode remains valid that the system sends by email.

*Added In:** 18.1.2

*SCIM++ Properties:** - idcsMaxValue: 60 - idcsMinValue: 2 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

getEmailPasscodeLength

public Integer getEmailPasscodeLength()

Exact length of the email one-time passcode.

*Added In:** 18.1.2

*SCIM++ Properties:** - idcsMaxValue: 10 - idcsMinValue: 4 - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: integer - uniqueness: none

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel