Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AuthenticationFactorSettingsBypassCodeSettings

Settings related to the bypass code, such as bypass code length, bypass code expiry, max active bypass codes, and so on

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: complex - uniqueness: none

Properties

Functions

Properties

helpDeskCodeExpiryInMins

helpDeskCodeExpiryInMins: number

Expiry (in minutes) of any bypass code that is generated by the help desk

*SCIM++ Properties:** - idcsMaxValue: 9999999 - idcsMinValue: 1 - 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.

helpDeskGenerationEnabled

helpDeskGenerationEnabled: boolean

If true, indicates that help desk bypass code generation is enabled

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

helpDeskMaxUsage

helpDeskMaxUsage: number

The maximum number of times that any bypass code that is generated by the help desk can be used

*SCIM++ Properties:** - idcsMaxValue: 999 - idcsMinValue: 1 - 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.

length

length: number

Exact length of the bypass code to be generated

*SCIM++ Properties:** - idcsMaxValue: 20 - idcsMinValue: 8 - 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.

maxActive

maxActive: number

The maximum number of bypass codes that can be issued to any user

*SCIM++ Properties:** - idcsMaxValue: 6 - idcsMinValue: 1 - 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.

selfServiceGenerationEnabled

selfServiceGenerationEnabled: boolean

If true, indicates that self-service bypass code generation is enabled

*SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: true - returned: default - type: boolean - uniqueness: none

Functions

getDeserializedJsonObj

getJsonObj