Update the time-based one-time password configuration.

put https://{tenanturl}/config/v2.0/factors/totp

Update the time-based one-time password configuration.

Entitlements:
- manageMFAMethods (Manage second-factor authentication method configuration)

Body Params

The updated configuration.

algorithm

string

required

The algorithm that is used to generate the one-time password

digits

int32

required

6 to 12

The number of digits of the one-time password

enabled

boolean

required

The enabled state of time-based one-time password to be used in runtime flows

keyUri

string

required

The URI format to use when providing secret keys

oneTimeUse

boolean

required

Whether one-time password values can only be used once within the given period

period

int32

required

1 to 1800

The number of seconds until the one-time password expires

periodSkew

int32

required

0 to 5

The period skew intervals to consider for synchronization delay between the server and client generating the one-time password. For example, a skew interval of 2 means a one-time password in up to two intervals in the past, or two in the future will be valid

enrollments

int32

1 to 5

The maximum number of enrollments a specific user may enroll

Responses

204

The configuration was updated.

Language

URL


xxxxxxxxxx
11
1
curl --request PUT \
2
     --url https://tenant_url/config/v2.0/factors/totp \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "algorithm": "SHA1",
8
  "enabled": true,
9
  "oneTimeUse": true
10
}
11
'

Choose an example:

application/json

400The request cannot be processed because the request body contains improperly structured JSON

401The unauthenticated user does not have the permissions to perform the requested operation

403The authenticated user does not have the permissions to perform the requested operation