Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

MethodDescriptionExample payload
PUT

Create or update TOTP method.

If configuration values are left out the defaults from below will be used.

methodType=SPI TOTP
className=ubilogin.method.provider.spi.DirectoryTOTPMethod
title=Acme Authenticator
configuration=totpAlgorithm HmacSHA1
configuration=totpKeySize 20
configuration=totpT0 0
configuration=totpTimeStep 30000
configuration=totpDigits 6
configuration=totpWindowBefore 1
configuration=totpWindowAfter 0

/sso-api/directory/Ubilogin%20Directory/$link/method/acme.totp.1

...

Number time steps in the past with valid codes. Can be a number between 0 and 9. Default is 1.

API key: totpWindowBefore

TOTP Future Window

Number time steps in the future with valid codes. Can be a number between 0 and 9. Default is 0.

API key: totpWindowAfter

TOTP Key Generation Configuration

...

The length of TOTP codes in digits. Can be a number between 4 and 8. Default is 6.

API key: totpDigits

TOTP Algorithm

The algorithm in which the TOTP algorithm is based on. Can be either HmacSHA1, HmacSHA256 or HmacSHA512. Default is HmacSHA1.

API key: totpAlgorithm

T0

The Unix time in milliseconds to start counting time steps. Default is 0.

API key: totpT0

Time Step

The duration of one time step in milliseconds. Default is 30000.

API key: totpTimeStep

Key Size

The length of generated keys in bytes. Can be a number between 10 and 99. Default is 20.

API key: totpKeySize

After Configuring the TOTP Method

...

Info

For other directories like SQL directory or external LDAP directory you need to use the TOTP API for managing the secrets. 

When using Active Directory, you muse must ensure that the directory.schema=Active Directory. Setting directory.schema=Generic will not work. 

In order to activate TOTP authentication method for an Ubilogin Directory user, you must first:

...