Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AuthenticationFactorSettingsTotpSettings

Settings 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

Properties

emailOtpValidityDurationInMins

emailOtpValidityDurationInMins: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

emailPasscodeLength

emailPasscodeLength: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

hashingAlgorithm

hashingAlgorithm: HashingAlgorithm

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

jwtValidityDurationInSecs

jwtValidityDurationInSecs: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

keyRefreshIntervalInDays

keyRefreshIntervalInDays: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

passcodeLength

passcodeLength: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

smsOtpValidityDurationInMins

smsOtpValidityDurationInMins: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

smsPasscodeLength

smsPasscodeLength: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeStepInSecs

timeStepInSecs: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeStepTolerance

timeStepTolerance: number

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 Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj