AuthenticationFactorSettingsTotpSettings¶
- class oci.identity_domains.models.AuthenticationFactorSettingsTotpSettings(**kwargs)¶
Bases:
objectSettings 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
Attributes:
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings.
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings.
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings.
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings.
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings.
[Required] Gets the email_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the email_passcode_length of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the hashing_algorithm of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the jwt_validity_duration_in_secs of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the key_refresh_interval_in_days of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the passcode_length of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the sms_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the sms_passcode_length of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the time_step_in_secs of this AuthenticationFactorSettingsTotpSettings.
[Required] Gets the time_step_tolerance of this AuthenticationFactorSettingsTotpSettings.
Methods:
__init__(**kwargs)Initializes a new AuthenticationFactorSettingsTotpSettings object with values from keyword arguments.
- HASHING_ALGORITHM_MD5 = 'MD5'¶
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings. This constant has a value of “MD5”
- HASHING_ALGORITHM_SHA1 = 'SHA1'¶
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings. This constant has a value of “SHA1”
- HASHING_ALGORITHM_SHA256 = 'SHA256'¶
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings. This constant has a value of “SHA256”
- HASHING_ALGORITHM_SHA384 = 'SHA384'¶
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings. This constant has a value of “SHA384”
- HASHING_ALGORITHM_SHA512 = 'SHA512'¶
A constant which can be used with the hashing_algorithm property of a AuthenticationFactorSettingsTotpSettings. This constant has a value of “SHA512”
- __init__(**kwargs)¶
Initializes a new AuthenticationFactorSettingsTotpSettings object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
hashing_algorithm (str) – The value to assign to the hashing_algorithm property of this AuthenticationFactorSettingsTotpSettings. Allowed values for this property are: “SHA1”, “SHA256”, “SHA384”, “SHA512”, “MD5”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
passcode_length (int) – The value to assign to the passcode_length property of this AuthenticationFactorSettingsTotpSettings.
key_refresh_interval_in_days (int) – The value to assign to the key_refresh_interval_in_days property of this AuthenticationFactorSettingsTotpSettings.
time_step_in_secs (int) – The value to assign to the time_step_in_secs property of this AuthenticationFactorSettingsTotpSettings.
time_step_tolerance (int) – The value to assign to the time_step_tolerance property of this AuthenticationFactorSettingsTotpSettings.
sms_otp_validity_duration_in_mins (int) – The value to assign to the sms_otp_validity_duration_in_mins property of this AuthenticationFactorSettingsTotpSettings.
jwt_validity_duration_in_secs (int) – The value to assign to the jwt_validity_duration_in_secs property of this AuthenticationFactorSettingsTotpSettings.
sms_passcode_length (int) – The value to assign to the sms_passcode_length property of this AuthenticationFactorSettingsTotpSettings.
email_otp_validity_duration_in_mins (int) – The value to assign to the email_otp_validity_duration_in_mins property of this AuthenticationFactorSettingsTotpSettings.
email_passcode_length (int) – The value to assign to the email_passcode_length property of this AuthenticationFactorSettingsTotpSettings.
- property email_otp_validity_duration_in_mins¶
[Required] Gets the email_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings. 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 email_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property email_passcode_length¶
[Required] Gets the email_passcode_length of this AuthenticationFactorSettingsTotpSettings. 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 email_passcode_length of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property hashing_algorithm¶
[Required] Gets the hashing_algorithm of this AuthenticationFactorSettingsTotpSettings. 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
Allowed values for this property are: “SHA1”, “SHA256”, “SHA384”, “SHA512”, “MD5”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The hashing_algorithm of this AuthenticationFactorSettingsTotpSettings.
- Return type
str
- property jwt_validity_duration_in_secs¶
[Required] Gets the jwt_validity_duration_in_secs of this AuthenticationFactorSettingsTotpSettings. 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 jwt_validity_duration_in_secs of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property key_refresh_interval_in_days¶
[Required] Gets the key_refresh_interval_in_days of this AuthenticationFactorSettingsTotpSettings. 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 key_refresh_interval_in_days of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property passcode_length¶
[Required] Gets the passcode_length of this AuthenticationFactorSettingsTotpSettings. 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 passcode_length of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property sms_otp_validity_duration_in_mins¶
[Required] Gets the sms_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings. 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 sms_otp_validity_duration_in_mins of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property sms_passcode_length¶
[Required] Gets the sms_passcode_length of this AuthenticationFactorSettingsTotpSettings. 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 sms_passcode_length of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property time_step_in_secs¶
[Required] Gets the time_step_in_secs of this AuthenticationFactorSettingsTotpSettings. 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 time_step_in_secs of this AuthenticationFactorSettingsTotpSettings.
- Return type
int
- property time_step_tolerance¶
[Required] Gets the time_step_tolerance of this AuthenticationFactorSettingsTotpSettings. 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 time_step_tolerance of this AuthenticationFactorSettingsTotpSettings.
- Return type
int