Class AuthenticationFactorSettingsClientAppSettings
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
Inherited Members
Namespace: Oci.IdentitydomainsService.Models
Assembly: OCI.DotNetSDK.Identitydomains.dll
Syntax
public class AuthenticationFactorSettingsClientAppSettingsProperties
DeviceProtectionPolicy
Declaration
[Required(ErrorMessage = "DeviceProtectionPolicy is required.")]
[JsonProperty(PropertyName = "deviceProtectionPolicy")]
public string DeviceProtectionPolicy { get; set; }Property Value
| Type | Description |
|---|---|
| string | 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.
|
Remarks
Required
InitialLockoutPeriodInSecs
Declaration
[Required(ErrorMessage = "InitialLockoutPeriodInSecs is required.")]
[JsonProperty(PropertyName = "initialLockoutPeriodInSecs")]
public int? InitialLockoutPeriodInSecs { get; set; }Property Value
| Type | Description |
|---|---|
| int? | 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
|
Remarks
Required
KeyPairLength
Declaration
[Required(ErrorMessage = "KeyPairLength is required.")]
[JsonProperty(PropertyName = "keyPairLength")]
public int? KeyPairLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The size of the key that the system uses to generate the public-private key pair
|
Remarks
Required
LockoutEscalationPattern
Declaration
[Required(ErrorMessage = "LockoutEscalationPattern is required.")]
[JsonProperty(PropertyName = "lockoutEscalationPattern")]
public string LockoutEscalationPattern { get; set; }Property Value
| Type | Description |
|---|---|
| string | The pattern of escalation that the system follows, in locking a particular user out of the service.
|
Remarks
Required
MaxFailuresBeforeLockout
Declaration
[Required(ErrorMessage = "MaxFailuresBeforeLockout is required.")]
[JsonProperty(PropertyName = "maxFailuresBeforeLockout")]
public int? MaxFailuresBeforeLockout { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum number of times that a particular user can fail to login before the system locks that user out of the service
|
Remarks
Required
MaxFailuresBeforeWarning
Declaration
[Required(ErrorMessage = "MaxFailuresBeforeWarning is required.")]
[JsonProperty(PropertyName = "maxFailuresBeforeWarning")]
public int? MaxFailuresBeforeWarning { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The maximum number of login failures that the system will allow before raising a warning and sending an alert via email
|
Remarks
Required
MaxLockoutIntervalInSecs
Declaration
[Required(ErrorMessage = "MaxLockoutIntervalInSecs is required.")]
[JsonProperty(PropertyName = "maxLockoutIntervalInSecs")]
public int? MaxLockoutIntervalInSecs { get; set; }Property Value
| Type | Description |
|---|---|
| int? | 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
|
Remarks
Required
MinPinLength
Declaration
[Required(ErrorMessage = "MinPinLength is required.")]
[JsonProperty(PropertyName = "minPinLength")]
public int? MinPinLength { get; set; }Property Value
| Type | Description |
|---|---|
| int? | Minimum length of the Personal Identification Number (PIN)
|
Remarks
Required
PolicyUpdateFreqInDays
Declaration
[Required(ErrorMessage = "PolicyUpdateFreqInDays is required.")]
[JsonProperty(PropertyName = "policyUpdateFreqInDays")]
public int? PolicyUpdateFreqInDays { get; set; }Property Value
| Type | Description |
|---|---|
| int? | The period of time in days after which a client should refresh its policy by re-reading that policy from the server
|
Remarks
Required
RequestSigningAlgo
Declaration
[Required(ErrorMessage = "RequestSigningAlgo is required.")]
[JsonProperty(PropertyName = "requestSigningAlgo")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgoEnum? RequestSigningAlgo { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsClientAppSettings.RequestSigningAlgoEnum? | Indicates which algorithm the system will use to sign requests
|
Remarks
Required
SharedSecretEncoding
Declaration
[Required(ErrorMessage = "SharedSecretEncoding is required.")]
[JsonProperty(PropertyName = "sharedSecretEncoding")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuthenticationFactorSettingsClientAppSettings.SharedSecretEncodingEnum? SharedSecretEncoding { get; set; }Property Value
| Type | Description |
|---|---|
| AuthenticationFactorSettingsClientAppSettings.SharedSecretEncodingEnum? | Indicates the type of encoding that the system should use to generate a shared secret
|
Remarks
Required
UnlockAppForEachRequestEnabled
Declaration
[Required(ErrorMessage = "UnlockAppForEachRequestEnabled is required.")]
[JsonProperty(PropertyName = "unlockAppForEachRequestEnabled")]
public bool? UnlockAppForEachRequestEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
Remarks
Required
UnlockAppIntervalInSecs
Declaration
[Required(ErrorMessage = "UnlockAppIntervalInSecs is required.")]
[JsonProperty(PropertyName = "unlockAppIntervalInSecs")]
public int? UnlockAppIntervalInSecs { get; set; }Property Value
| Type | Description |
|---|---|
| int? | 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.
|
Remarks
Required
UnlockOnAppForegroundEnabled
Declaration
[Required(ErrorMessage = "UnlockOnAppForegroundEnabled is required.")]
[JsonProperty(PropertyName = "unlockOnAppForegroundEnabled")]
public bool? UnlockOnAppForegroundEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
Remarks
Required
UnlockOnAppStartEnabled
Declaration
[Required(ErrorMessage = "UnlockOnAppStartEnabled is required.")]
[JsonProperty(PropertyName = "unlockOnAppStartEnabled")]
public bool? UnlockOnAppStartEnabled { get; set; }Property Value
| Type | Description |
|---|---|
| bool? | 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.
|
Remarks
Required