Skip to content

/AWS1/CL_PPUCODECONFPARAMETERS

The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_codetype TYPE /AWS1/PPUCODETYPE /AWS1/PPUCODETYPE

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.

iv_codelength TYPE /AWS1/PPUCODELENGTH /AWS1/PPUCODELENGTH

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.

iv_validityperiodminutes TYPE /AWS1/PPUVALIDITYPERIODMINUTES /AWS1/PPUVALIDITYPERIODMINUTES

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.

iv_maxattempts TYPE /AWS1/PPUMAXVERIFATTEMPTS /AWS1/PPUMAXVERIFATTEMPTS

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.


Queryable Attributes

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.

Accessible with the following methods

Method Description
GET_CODETYPE() Getter for CODETYPE, with configurable default
ASK_CODETYPE() Getter for CODETYPE w/ exceptions if field has no value
HAS_CODETYPE() Determine if CODETYPE has a value

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.

Accessible with the following methods

Method Description
GET_CODELENGTH() Getter for CODELENGTH, with configurable default
ASK_CODELENGTH() Getter for CODELENGTH w/ exceptions if field has no value
HAS_CODELENGTH() Determine if CODELENGTH has a value

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.

Accessible with the following methods

Method Description
GET_VALIDITYPERIODMINUTES() Getter for VALIDITYPERIODMINUTES, with configurable default
ASK_VALIDITYPERIODMINUTES() Getter for VALIDITYPERIODMINUTES w/ exceptions if field has
HAS_VALIDITYPERIODMINUTES() Determine if VALIDITYPERIODMINUTES has a value

maxAttempts

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.

Accessible with the following methods

Method Description
GET_MAXATTEMPTS() Getter for MAXATTEMPTS, with configurable default
ASK_MAXATTEMPTS() Getter for MAXATTEMPTS w/ exceptions if field has no value
HAS_MAXATTEMPTS() Determine if MAXATTEMPTS has a value