Skip to content

CodeConfigurationParameters

Used by
Source code in docs_src/capo_endusermessaging/types/code_configuration_parameters.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
class CodeConfigurationParameters(TypedDict, closed=True):
    code_type: NotRequired["capo_endusermessaging.types.code_type.CodeType"]
    """<p>The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.</p>"""
    code_length: NotRequired["capo_endusermessaging.types.code_length.CodeLength"]
    """<p>The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.</p>"""
    validity_period_minutes: NotRequired[
        "capo_endusermessaging.types.validity_period_minutes.ValidityPeriodMinutes"
    ]
    """<p>The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.</p>"""
    max_attempts: NotRequired[
        "capo_endusermessaging.types.max_verification_attempts.MaxVerificationAttempts"
    ]
    """<p>The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.</p>"""

code_length instance-attribute 

code_length: NotRequired[CodeLength]

The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

code_type instance-attribute 

code_type: NotRequired[CodeType]

The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

max_attempts instance-attribute 

max_attempts: NotRequired[MaxVerificationAttempts]

The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

validity_period_minutes instance-attribute 

validity_period_minutes: NotRequired[ValidityPeriodMinutes]

The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.