IAdmTotpEnrollmentOps

The IAdmTotpEnrollmentOps interface is used to manage user enrollment for time-based one-time password (TOTP) authentication.

Inheritance: IUnknown

Methods

Details

GenerateSecretKey()

Generates a secret key used to enroll the user for time-based one-time password authentication.

IAdmTotpSecretKeyInfo GenerateSecretKey()

GetApplicationsUserEnrolledIn()

Returns the TOTP applications activated by the user.

ADM_TOTPENROLLMENTAPPLICATION_ENUM[] GetApplicationsUserEnrolledIn()

GetActivationTime()

Returns the date and time when the user activated the specified TOTP application.

DateTime GetActivationTime(ADM_TOTPENROLLMENTAPPLICATION_ENUM application)

GetLastActivationTime()

Returns the date and time when the user last activated a TOTP application.

DateTime GetLastActivationTime()

VerifyOneTimePassword()

Returns a value indicating whether the specified one-time password is valid for the given TOTP application.

Boolean VerifyOneTimePassword(ADM_TOTPENROLLMENTAPPLICATION_ENUM application, 
                              String oneTimePassword)

Parameters

  • application - Specifies the mobile application to validate the one-time password for.
  • oneTimePassword - Specifies a one-time password.

PreCheckSecretKey()

Returns a value indicating whether the specified secret key is valid for the given one-time password.

Boolean PreCheckSecretKey(String secretKey, String oneTimePassword)

Parameters


EnrollTotp()

Enrolls the user for TOTP authentication.

void EnrollTotp(ADM_TOTPENROLLMENTAPPLICATION_ENUM application, 
                String secretKey, 
                String oneTimePassword)

Parameters

  • application - Specifies the TOTP application to activate.
  • secretKey - Specifies a secret key for enrollment. To get the key, use property IAdmTotpSecretKeyInfo::SecretKey.
  • oneTimePassword - Specifies a one-time password.

DisenrollTotp()

Deactivates the specified TOTP applications for the user.

void DisenrollTotp(ADM_TOTPENROLLMENTAPPLICATION_ENUM[] applications)

Requirements

Minimum required version: 2019.2

See also