com.oracle.bmc.identitydomains.model

Class AuthenticationFactorSettingsClientAppSettings.Builder

java.lang.Object

com.oracle.bmc.identitydomains.model.AuthenticationFactorSettingsClientAppSettings.Builder

Enclosing class:

AuthenticationFactorSettingsClientAppSettings

public static class AuthenticationFactorSettingsClientAppSettings.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuthenticationFactorSettingsClientAppSettings	build()
AuthenticationFactorSettingsClientAppSettings.Builder	copy(AuthenticationFactorSettingsClientAppSettings model)
AuthenticationFactorSettingsClientAppSettings.Builder	deviceProtectionPolicy(String deviceProtectionPolicy) Indicates what protection policy that the system applies on a device.
AuthenticationFactorSettingsClientAppSettings.Builder	initialLockoutPeriodInSecs(Integer initialLockoutPeriodInSecs) 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
AuthenticationFactorSettingsClientAppSettings.Builder	keyPairLength(Integer keyPairLength) The size of the key that the system uses to generate the public-private key pair
AuthenticationFactorSettingsClientAppSettings.Builder	lockoutEscalationPattern(String lockoutEscalationPattern) The pattern of escalation that the system follows, in locking a particular user out of the service.
AuthenticationFactorSettingsClientAppSettings.Builder	maxFailuresBeforeLockout(Integer maxFailuresBeforeLockout) The maximum number of times that a particular user can fail to login before the system locks that user out of the service
AuthenticationFactorSettingsClientAppSettings.Builder	maxFailuresBeforeWarning(Integer maxFailuresBeforeWarning) The maximum number of login failures that the system will allow before raising a warning and sending an alert via email
AuthenticationFactorSettingsClientAppSettings.Builder	maxLockoutIntervalInSecs(Integer maxLockoutIntervalInSecs) 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
AuthenticationFactorSettingsClientAppSettings.Builder	minPinLength(Integer minPinLength) Minimum length of the Personal Identification Number (PIN)
AuthenticationFactorSettingsClientAppSettings.Builder	policyUpdateFreqInDays(Integer policyUpdateFreqInDays) The period of time in days after which a client should refresh its policy by re-reading that policy from the server
AuthenticationFactorSettingsClientAppSettings.Builder	requestSigningAlgo(AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo requestSigningAlgo) Indicates which algorithm the system will use to sign requests
AuthenticationFactorSettingsClientAppSettings.Builder	sharedSecretEncoding(AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding sharedSecretEncoding) Indicates the type of encoding that the system should use to generate a shared secret
AuthenticationFactorSettingsClientAppSettings.Builder	unlockAppForEachRequestEnabled(Boolean unlockAppForEachRequestEnabled) If true, indicates that the system should require the user to unlock the client app for each request.
AuthenticationFactorSettingsClientAppSettings.Builder	unlockAppIntervalInSecs(Integer unlockAppIntervalInSecs) Specifies the period of time in seconds after which the client App should require the user to unlock the App.
AuthenticationFactorSettingsClientAppSettings.Builder	unlockOnAppForegroundEnabled(Boolean unlockOnAppForegroundEnabled) 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.
AuthenticationFactorSettingsClientAppSettings.Builder	unlockOnAppStartEnabled(Boolean unlockOnAppStartEnabled) If true, indicates that the system should require the user to unlock the client App whenever the App is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

minPinLength

public AuthenticationFactorSettingsClientAppSettings.Builder minPinLength(Integer minPinLength)

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

Parameters:

minPinLength - the value to set

Returns:

this builder

maxFailuresBeforeWarning

public AuthenticationFactorSettingsClientAppSettings.Builder maxFailuresBeforeWarning(Integer maxFailuresBeforeWarning)

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

Parameters:

maxFailuresBeforeWarning - the value to set

Returns:

this builder

maxFailuresBeforeLockout

public AuthenticationFactorSettingsClientAppSettings.Builder maxFailuresBeforeLockout(Integer maxFailuresBeforeLockout)

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

Parameters:

maxFailuresBeforeLockout - the value to set

Returns:

this builder

initialLockoutPeriodInSecs

public AuthenticationFactorSettingsClientAppSettings.Builder initialLockoutPeriodInSecs(Integer initialLockoutPeriodInSecs)

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

Parameters:

initialLockoutPeriodInSecs - the value to set

Returns:

this builder

lockoutEscalationPattern

public AuthenticationFactorSettingsClientAppSettings.Builder lockoutEscalationPattern(String lockoutEscalationPattern)

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

Parameters:

lockoutEscalationPattern - the value to set

Returns:

this builder

maxLockoutIntervalInSecs

public AuthenticationFactorSettingsClientAppSettings.Builder maxLockoutIntervalInSecs(Integer maxLockoutIntervalInSecs)

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

Parameters:

maxLockoutIntervalInSecs - the value to set

Returns:

this builder

requestSigningAlgo

public AuthenticationFactorSettingsClientAppSettings.Builder requestSigningAlgo(AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgo requestSigningAlgo)

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

Parameters:

requestSigningAlgo - the value to set

Returns:

this builder

policyUpdateFreqInDays

public AuthenticationFactorSettingsClientAppSettings.Builder policyUpdateFreqInDays(Integer policyUpdateFreqInDays)

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

Parameters:

policyUpdateFreqInDays - the value to set

Returns:

this builder

keyPairLength

public AuthenticationFactorSettingsClientAppSettings.Builder keyPairLength(Integer keyPairLength)

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

Parameters:

keyPairLength - the value to set

Returns:

this builder

deviceProtectionPolicy

public AuthenticationFactorSettingsClientAppSettings.Builder deviceProtectionPolicy(String deviceProtectionPolicy)

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

Parameters:

deviceProtectionPolicy - the value to set

Returns:

this builder

unlockAppForEachRequestEnabled

public AuthenticationFactorSettingsClientAppSettings.Builder unlockAppForEachRequestEnabled(Boolean unlockAppForEachRequestEnabled)

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

Parameters:

unlockAppForEachRequestEnabled - the value to set

Returns:

this builder

unlockOnAppStartEnabled

public AuthenticationFactorSettingsClientAppSettings.Builder unlockOnAppStartEnabled(Boolean unlockOnAppStartEnabled)

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

Parameters:

unlockOnAppStartEnabled - the value to set

Returns:

this builder

unlockAppIntervalInSecs

public AuthenticationFactorSettingsClientAppSettings.Builder unlockAppIntervalInSecs(Integer unlockAppIntervalInSecs)

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

Parameters:

unlockAppIntervalInSecs - the value to set

Returns:

this builder

sharedSecretEncoding

public AuthenticationFactorSettingsClientAppSettings.Builder sharedSecretEncoding(AuthenticationFactorSettingsClientAppSettings.SharedSecretEncoding sharedSecretEncoding)

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

Parameters:

sharedSecretEncoding - the value to set

Returns:

this builder

unlockOnAppForegroundEnabled

public AuthenticationFactorSettingsClientAppSettings.Builder unlockOnAppForegroundEnabled(Boolean unlockOnAppForegroundEnabled)

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

Parameters:

unlockOnAppForegroundEnabled - the value to set

Returns:

this builder

build

public AuthenticationFactorSettingsClientAppSettings build()

copy

public AuthenticationFactorSettingsClientAppSettings.Builder copy(AuthenticationFactorSettingsClientAppSettings model)