Package com.oracle.bmc.identitydomains.model

Class AuthenticationFactorSettingsClientAppSettings

java.lang.Object

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

com.oracle.bmc.identitydomains.model.AuthenticationFactorSettingsClientAppSettings

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

Settings related to compliance, Personal Identification Number (PIN) policy, 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 AuthenticationFactorSettingsClientAppSettings.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 AuthenticationFactorSettingsClientAppSettings.Builder, which maintain a set of all explicitly set fields called AuthenticationFactorSettingsClientAppSettings.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	AuthenticationFactorSettingsClientAppSettings.Builder
static class	AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo	Indicates which algorithm the system will use to sign requests
static class	AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding	Indicates the type of encoding that the system should use to generate a shared secret

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

AuthenticationFactorSettingsClientAppSettings(Integer minPinLength, Integer maxFailuresBeforeWarning, Integer maxFailuresBeforeLockout, Integer initialLockoutPeriodInSecs, String lockoutEscalationPattern, Integer maxLockoutIntervalInSecs, AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo requestSigningAlgo, Integer policyUpdateFreqInDays, Integer keyPairLength, String deviceProtectionPolicy, Boolean unlockAppForEachRequestEnabled, Boolean unlockOnAppStartEnabled, Integer unlockAppIntervalInSecs, AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding sharedSecretEncoding, Boolean unlockOnAppForegroundEnabled)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static AuthenticationFactorSettingsClientAppSettings.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDeviceProtectionPolicy()	Indicates what protection policy that the system applies on a device.
Integer	getInitialLockoutPeriodInSecs()	The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures
Integer	getKeyPairLength()	The size of the key that the system uses to generate the public-private key pair
String	getLockoutEscalationPattern()	The pattern of escalation that the system follows, in locking a particular user out of the service.
Integer	getMaxFailuresBeforeLockout()	The maximum number of times that a particular user can fail to login before the system locks that user out of the service
Integer	getMaxFailuresBeforeWarning()	The maximum number of login failures that the system will allow before raising a warning and sending an alert via email
Integer	getMaxLockoutIntervalInSecs()	The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate
Integer	getMinPinLength()	Minimum length of the Personal Identification Number (PIN)
Integer	getPolicyUpdateFreqInDays()	The period of time in days after which a client should refresh its policy by re-reading that policy from the server
AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo	getRequestSigningAlgo()	Indicates which algorithm the system will use to sign requests
AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding	getSharedSecretEncoding()	Indicates the type of encoding that the system should use to generate a shared secret
Boolean	getUnlockAppForEachRequestEnabled()	If true, indicates that the system should require the user to unlock the client app for each request.
Integer	getUnlockAppIntervalInSecs()	Specifies the period of time in seconds after which the client App should require the user to unlock the App.
Boolean	getUnlockOnAppForegroundEnabled()	If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device.
Boolean	getUnlockOnAppStartEnabled()	If true, indicates that the system should require the user to unlock the client App whenever the App is started.
int	hashCode()
AuthenticationFactorSettingsClientAppSettings.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

AuthenticationFactorSettingsClientAppSettings

@Deprecated
@ConstructorProperties({"minPinLength","maxFailuresBeforeWarning","maxFailuresBeforeLockout","initialLockoutPeriodInSecs","lockoutEscalationPattern","maxLockoutIntervalInSecs","requestSigningAlgo","policyUpdateFreqInDays","keyPairLength","deviceProtectionPolicy","unlockAppForEachRequestEnabled","unlockOnAppStartEnabled","unlockAppIntervalInSecs","sharedSecretEncoding","unlockOnAppForegroundEnabled"})
public AuthenticationFactorSettingsClientAppSettings(Integer minPinLength,
                                                     Integer maxFailuresBeforeWarning,
                                                     Integer maxFailuresBeforeLockout,
                                                     Integer initialLockoutPeriodInSecs,
                                                     String lockoutEscalationPattern,
                                                     Integer maxLockoutIntervalInSecs,
                                                     AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo requestSigningAlgo,
                                                     Integer policyUpdateFreqInDays,
                                                     Integer keyPairLength,
                                                     String deviceProtectionPolicy,
                                                     Boolean unlockAppForEachRequestEnabled,
                                                     Boolean unlockOnAppStartEnabled,
                                                     Integer unlockAppIntervalInSecs,
                                                     AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding sharedSecretEncoding,
                                                     Boolean unlockOnAppForegroundEnabled)

Deprecated.

Method Detail

builder

public static AuthenticationFactorSettingsClientAppSettings.Builder builder()

Create a new builder.

toBuilder

public AuthenticationFactorSettingsClientAppSettings.Builder toBuilder()

getMinPinLength

public Integer getMinPinLength()

Minimum length of the Personal Identification Number (PIN)

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

Returns:

the value

getMaxFailuresBeforeWarning

public Integer getMaxFailuresBeforeWarning()

The maximum number of login failures that the system will allow before raising a warning and sending an alert via email

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

Returns:

the value

getMaxFailuresBeforeLockout

public Integer getMaxFailuresBeforeLockout()

The maximum number of times that a particular user can fail to login before the system locks that user out of the service

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

Returns:

the value

getInitialLockoutPeriodInSecs

public Integer getInitialLockoutPeriodInSecs()

The period of time in seconds that the system will lock a user out of the service after that user exceeds the maximum number of login failures

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

Returns:

the value

getLockoutEscalationPattern

public String getLockoutEscalationPattern()

The pattern of escalation that the system follows, in locking a particular user out of the service.

*SCIM++ Properties:** - idcsCanonicalValueSourceFilter: attrName eq "lockoutEscalationPattern" and attrValues.value eq "$(lockoutEscalationPattern)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

the value

getMaxLockoutIntervalInSecs

public Integer getMaxLockoutIntervalInSecs()

The maximum period of time that the system will lock a particular user out of the service regardless of what the configured pattern of escalation would otherwise dictate

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

Returns:

the value

getRequestSigningAlgo

public AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo getRequestSigningAlgo()

Indicates which algorithm the system will use to sign requests

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

Returns:

the value

getPolicyUpdateFreqInDays

public Integer getPolicyUpdateFreqInDays()

The period of time in days after which a client should refresh its policy by re-reading that policy from the server

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

Returns:

the value

getKeyPairLength

public Integer getKeyPairLength()

The size of the key that the system uses to generate the public-private key pair

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

Returns:

the value

getDeviceProtectionPolicy

public String getDeviceProtectionPolicy()

Indicates what protection policy that the system applies on a device.

By default, the value is NONE, which indicates that the system applies no protection policy. A value of APP_PIN indicates that the system requires a Personal Identification Number (PIN). A value of DEVICE_BIOMETRIC_OR_APP_PIN indicates that either a PIN or a biometric authentication factor is required.

*SCIM++ Properties:** - idcsCanonicalValueSourceFilter: attrName eq "deviceProtectionPolicy" and attrValues.value eq "$(deviceProtectionPolicy)" - idcsCanonicalValueSourceResourceType: AllowedValue - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: string - uniqueness: none

Returns:

the value

getUnlockAppForEachRequestEnabled

public Boolean getUnlockAppForEachRequestEnabled()

If true, indicates that the system should require the user to unlock the client app for each request.

In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.

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

Returns:

the value

getUnlockOnAppStartEnabled

public Boolean getUnlockOnAppStartEnabled()

If true, indicates that the system should require the user to unlock the client App whenever the App is started.

In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.

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

Returns:

the value

getUnlockAppIntervalInSecs

public Integer getUnlockAppIntervalInSecs()

Specifies the period of time in seconds after which the client App should require the user to unlock the App.

In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor. A value of zero means that it is disabled.

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

Returns:

the value

getSharedSecretEncoding

public AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding getSharedSecretEncoding()

Indicates the type of encoding that the system should use to generate a shared secret

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

Returns:

the value

getUnlockOnAppForegroundEnabled

public Boolean getUnlockOnAppForegroundEnabled()

If true, indicates that the system should require the user to unlock the client App, when the client App comes to the foreground in the display of the device.

In order to unlock the App, the user must supply a Personal Identification Number (PIN) or a biometric authentication-factor.

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - 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