AuthenticationFactorSettingsClientAppSettings¶

class oci.identity_domains.models.AuthenticationFactorSettingsClientAppSettings(**kwargs)¶

Bases: object

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

Attributes

`REQUEST_SIGNING_ALGO_SHA256WITH_RSA`	A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings.
`REQUEST_SIGNING_ALGO_SHA384WITH_RSA`	A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings.
`REQUEST_SIGNING_ALGO_SHA512WITH_RSA`	A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings.
`SHARED_SECRET_ENCODING_BASE32`	A constant which can be used with the shared_secret_encoding property of a AuthenticationFactorSettingsClientAppSettings.
`SHARED_SECRET_ENCODING_BASE64`	A constant which can be used with the shared_secret_encoding property of a AuthenticationFactorSettingsClientAppSettings.
`device_protection_policy`	[Required] Gets the device_protection_policy of this AuthenticationFactorSettingsClientAppSettings.
`initial_lockout_period_in_secs`	[Required] Gets the initial_lockout_period_in_secs of this AuthenticationFactorSettingsClientAppSettings.
`key_pair_length`	[Required] Gets the key_pair_length of this AuthenticationFactorSettingsClientAppSettings.
`lockout_escalation_pattern`	[Required] Gets the lockout_escalation_pattern of this AuthenticationFactorSettingsClientAppSettings.
`max_failures_before_lockout`	[Required] Gets the max_failures_before_lockout of this AuthenticationFactorSettingsClientAppSettings.
`max_failures_before_warning`	[Required] Gets the max_failures_before_warning of this AuthenticationFactorSettingsClientAppSettings.
`max_lockout_interval_in_secs`	[Required] Gets the max_lockout_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings.
`min_pin_length`	[Required] Gets the min_pin_length of this AuthenticationFactorSettingsClientAppSettings.
`policy_update_freq_in_days`	[Required] Gets the policy_update_freq_in_days of this AuthenticationFactorSettingsClientAppSettings.
`request_signing_algo`	[Required] Gets the request_signing_algo of this AuthenticationFactorSettingsClientAppSettings.
`shared_secret_encoding`	[Required] Gets the shared_secret_encoding of this AuthenticationFactorSettingsClientAppSettings.
`unlock_app_for_each_request_enabled`	[Required] Gets the unlock_app_for_each_request_enabled of this AuthenticationFactorSettingsClientAppSettings.
`unlock_app_interval_in_secs`	[Required] Gets the unlock_app_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings.
`unlock_on_app_foreground_enabled`	[Required] Gets the unlock_on_app_foreground_enabled of this AuthenticationFactorSettingsClientAppSettings.
`unlock_on_app_start_enabled`	[Required] Gets the unlock_on_app_start_enabled of this AuthenticationFactorSettingsClientAppSettings.

Methods

__init__(**kwargs) Initializes a new AuthenticationFactorSettingsClientAppSettings object with values from keyword arguments.

REQUEST_SIGNING_ALGO_SHA256WITH_RSA = 'SHA256withRSA'¶: A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings. This constant has a value of “SHA256withRSA”

REQUEST_SIGNING_ALGO_SHA384WITH_RSA = 'SHA384withRSA'¶: A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings. This constant has a value of “SHA384withRSA”

REQUEST_SIGNING_ALGO_SHA512WITH_RSA = 'SHA512withRSA'¶: A constant which can be used with the request_signing_algo property of a AuthenticationFactorSettingsClientAppSettings. This constant has a value of “SHA512withRSA”

SHARED_SECRET_ENCODING_BASE32 = 'Base32'¶: A constant which can be used with the shared_secret_encoding property of a AuthenticationFactorSettingsClientAppSettings. This constant has a value of “Base32”

SHARED_SECRET_ENCODING_BASE64 = 'Base64'¶: A constant which can be used with the shared_secret_encoding property of a AuthenticationFactorSettingsClientAppSettings. This constant has a value of “Base64”

__init__(**kwargs)¶

Initializes a new AuthenticationFactorSettingsClientAppSettings object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

min_pin_length (int) – The value to assign to the min_pin_length property of this AuthenticationFactorSettingsClientAppSettings.
max_failures_before_warning (int) – The value to assign to the max_failures_before_warning property of this AuthenticationFactorSettingsClientAppSettings.
max_failures_before_lockout (int) – The value to assign to the max_failures_before_lockout property of this AuthenticationFactorSettingsClientAppSettings.
initial_lockout_period_in_secs (int) – The value to assign to the initial_lockout_period_in_secs property of this AuthenticationFactorSettingsClientAppSettings.
lockout_escalation_pattern (str) – The value to assign to the lockout_escalation_pattern property of this AuthenticationFactorSettingsClientAppSettings.
max_lockout_interval_in_secs (int) – The value to assign to the max_lockout_interval_in_secs property of this AuthenticationFactorSettingsClientAppSettings.
request_signing_algo (str) – The value to assign to the request_signing_algo property of this AuthenticationFactorSettingsClientAppSettings. Allowed values for this property are: “SHA256withRSA”, “SHA384withRSA”, “SHA512withRSA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
policy_update_freq_in_days (int) – The value to assign to the policy_update_freq_in_days property of this AuthenticationFactorSettingsClientAppSettings.
key_pair_length (int) – The value to assign to the key_pair_length property of this AuthenticationFactorSettingsClientAppSettings.
device_protection_policy (str) – The value to assign to the device_protection_policy property of this AuthenticationFactorSettingsClientAppSettings.
unlock_app_for_each_request_enabled (bool) – The value to assign to the unlock_app_for_each_request_enabled property of this AuthenticationFactorSettingsClientAppSettings.
unlock_on_app_start_enabled (bool) – The value to assign to the unlock_on_app_start_enabled property of this AuthenticationFactorSettingsClientAppSettings.
unlock_app_interval_in_secs (int) – The value to assign to the unlock_app_interval_in_secs property of this AuthenticationFactorSettingsClientAppSettings.
shared_secret_encoding (str) – The value to assign to the shared_secret_encoding property of this AuthenticationFactorSettingsClientAppSettings. Allowed values for this property are: “Base32”, “Base64”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
unlock_on_app_foreground_enabled (bool) – The value to assign to the unlock_on_app_foreground_enabled property of this AuthenticationFactorSettingsClientAppSettings.

device_protection_policy¶

[Required] Gets the device_protection_policy of this AuthenticationFactorSettingsClientAppSettings. 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 device_protection_policy of this AuthenticationFactorSettingsClientAppSettings.
Return type:	str

initial_lockout_period_in_secs¶

[Required] Gets the initial_lockout_period_in_secs of this AuthenticationFactorSettingsClientAppSettings. 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 initial_lockout_period_in_secs of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

key_pair_length¶

[Required] Gets the key_pair_length of this AuthenticationFactorSettingsClientAppSettings. 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 key_pair_length of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

lockout_escalation_pattern¶

[Required] Gets the lockout_escalation_pattern of this AuthenticationFactorSettingsClientAppSettings. 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 lockout_escalation_pattern of this AuthenticationFactorSettingsClientAppSettings.
Return type:	str

max_failures_before_lockout¶

[Required] Gets the max_failures_before_lockout of this AuthenticationFactorSettingsClientAppSettings. 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 max_failures_before_lockout of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

max_failures_before_warning¶

[Required] Gets the max_failures_before_warning of this AuthenticationFactorSettingsClientAppSettings. 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 max_failures_before_warning of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

max_lockout_interval_in_secs¶

[Required] Gets the max_lockout_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings. 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 max_lockout_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

min_pin_length¶

[Required] Gets the min_pin_length of this AuthenticationFactorSettingsClientAppSettings. 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 min_pin_length of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

policy_update_freq_in_days¶

[Required] Gets the policy_update_freq_in_days of this AuthenticationFactorSettingsClientAppSettings. 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 policy_update_freq_in_days of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

request_signing_algo¶

[Required] Gets the request_signing_algo of this AuthenticationFactorSettingsClientAppSettings. 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

Allowed values for this property are: “SHA256withRSA”, “SHA384withRSA”, “SHA512withRSA”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The request_signing_algo of this AuthenticationFactorSettingsClientAppSettings.
Return type:	str

shared_secret_encoding¶

[Required] Gets the shared_secret_encoding of this AuthenticationFactorSettingsClientAppSettings. 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

Allowed values for this property are: “Base32”, “Base64”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The shared_secret_encoding of this AuthenticationFactorSettingsClientAppSettings.
Return type:	str

unlock_app_for_each_request_enabled¶

[Required] Gets the unlock_app_for_each_request_enabled of this AuthenticationFactorSettingsClientAppSettings. 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 unlock_app_for_each_request_enabled of this AuthenticationFactorSettingsClientAppSettings.
Return type:	bool

unlock_app_interval_in_secs¶

[Required] Gets the unlock_app_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings. 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 unlock_app_interval_in_secs of this AuthenticationFactorSettingsClientAppSettings.
Return type:	int

unlock_on_app_foreground_enabled¶

[Required] Gets the unlock_on_app_foreground_enabled of this AuthenticationFactorSettingsClientAppSettings. 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 unlock_on_app_foreground_enabled of this AuthenticationFactorSettingsClientAppSettings.
Return type:	bool

unlock_on_app_start_enabled¶

[Required] Gets the unlock_on_app_start_enabled of this AuthenticationFactorSettingsClientAppSettings. 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 unlock_on_app_start_enabled of this AuthenticationFactorSettingsClientAppSettings.
Return type:	bool