pdftools_sdk.crypto.providers.swisscom_sig_srv.step_up

Module Attributes

ConsentRequiredFunc

Event containing the URL for step-up authentication using password and SMS challenge (OTP).

Classes

StepUp(msisdn, message, language)

The options for step-up authorization using Mobile ID

pdftools_sdk.crypto.providers.swisscom_sig_srv.step_up.ConsentRequiredFunc

Event containing the URL for step-up authentication using password and SMS challenge (OTP). Password and SMS challenge are used as a fallback mechanism for the Mobile ID authentication. For example, if the Mobile ID of the user is not activated. The user must be redirected to this URL for consent of will.

Parameters:

url (str) – The consent URL where the user must be redirected to acknowledge the declaration of will.

alias of Callable[[str], None]

class pdftools_sdk.crypto.providers.swisscom_sig_srv.step_up.StepUp(msisdn: str, message: str, language: str)

Bases: _NativeObject

The options for step-up authorization using Mobile ID

__init__(msisdn: str, message: str, language: str)

Parameters:

• msisdn (str) – The mobile phone number

• message (str) – The message to be displayed on the mobile phone

• language (str) – The language of the message

property m_s_i_s_d_n: str

The mobile phone number

Example: “+41798765432”

Returns:

str

property message: str

The message to be displayed on the mobile phone

Example: “Do you authorize your signature on Contract.pdf?”

Returns:

str

property language: str

The language of the message

Example: “DE”

Returns:

str

add_consent_required_handler(handler: Callable[[str], None]) → None

Add handler for the ConsentRequiredFunc() event.

Parameters:

handler – Event handler. If a handler is added that is already registered, it is ignored.

remove_consent_required_handler(handler: Callable[[str], None]) → None

Remove registered handler of the ConsentRequiredFunc() event.

Parameters:

handler – Event handler that shall be removed. If a handler is not registered, it is ignored.