TOTP

Time-based One-Time Password (TOTP) credential as defined by RFC 6238. Used to generate or verify the time-stepped codes presented during multi-factor authentication.

Create a new totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

One of:

digits	integer <uint16> Default: 6 Number of digits to enter as passcode.
algorithm	string <digest-type> Default: "sha1" `sha1` `sha224` `sha256` `sha384` `sha512` Digest types. sha1 is retained only for backward compatibility of existing configuration; it is broken for signatures and is floored to sha256 at signing time. Hash algorithm used to derive the TOTP code.
key-size	integer <uint16> Size of secret key. Default depends on algorithm sha1: 20 sha224: 32 sha256: 32 sha384: 64 sha512: 64
period	string <duration> Default: "30s" A duration in years, days, hours, minutes and seconds. Format is `[<digits>y][<digits>d][<digits>m][<digits>s]`. Examples: `1y2d5h`, `5h` or `10m30s` Re-generation period.
issuer	string Default: "unknown" The issuer parameter is a string value indicating the provider or service this account is associated with, URL-encoded according to RFC 3986. If the issuer parameter is absent it will default to `unknown`. The string may not contain colon.
account-name	string Default: "unknown" A unique name associated with the account. Typically the users email address is used. The string may not contain colon. The only purpose of this string is to help the end user associate the instance with the usage.
skew	integer <uint16> Default: 1 Number of periods before and after that are considered valid, ie a skew of 1 allows codes that were valid one period before and are valid one period after to be valid for the current period. This allows for some clock skew.
passcode32	string Optional pre-shared TOTP secret in base32 encoding. When supplied, this value is used in place of a randomly generated secret.
name	string <name> Generic strongbox name string, 1 to 1024 characters. Unique name of this TOTP credential within the tenant.
	to (object) or sites (object) or deployments (object) Default: "to" Selects how this object is distributed across sites.

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict (instance exists)

503

Service Unavailable (strongbox sealed)

post/v1/config/strongbox/totp

Request samples

Payload

name: admin
digits: 6
algorithm: sha1
key-size: 20
period: 30s
issuer: telco.com
account-name: admin@telco.com
skew: 1
passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
distribute:
  to: all

Retrieve the configuration of all totps

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
where	string Retrieve only items matching the given expression. See section where
validate	string <enumeration> Validate the request but do not actually perform the requested operation Value: "true"
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/strongbox/totp

Response samples

- name: admin
  digits: 6
  algorithm: sha1
  key-size: 20
  period: 30s
  issuer: telco.com
  account-name: admin@telco.com
  skew: 1
  passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
  distribute:
    to: all

Update a totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

One of:

digits	integer <uint16> Default: 6 Number of digits to enter as passcode.
algorithm	string <digest-type> Default: "sha1" `sha1` `sha224` `sha256` `sha384` `sha512` Digest types. sha1 is retained only for backward compatibility of existing configuration; it is broken for signatures and is floored to sha256 at signing time. Hash algorithm used to derive the TOTP code.
key-size	integer <uint16> Size of secret key. Default depends on algorithm sha1: 20 sha224: 32 sha256: 32 sha384: 64 sha512: 64
period	string <duration> Default: "30s" A duration in years, days, hours, minutes and seconds. Format is `[<digits>y][<digits>d][<digits>m][<digits>s]`. Examples: `1y2d5h`, `5h` or `10m30s` Re-generation period.
issuer	string Default: "unknown" The issuer parameter is a string value indicating the provider or service this account is associated with, URL-encoded according to RFC 3986. If the issuer parameter is absent it will default to `unknown`. The string may not contain colon.
account-name	string Default: "unknown" A unique name associated with the account. Typically the users email address is used. The string may not contain colon. The only purpose of this string is to help the end user associate the instance with the usage.
skew	integer <uint16> Default: 1 Number of periods before and after that are considered valid, ie a skew of 1 allows codes that were valid one period before and are valid one period after to be valid for the current period. This allows for some clock skew.
passcode32	string Optional pre-shared TOTP secret in base32 encoding. When supplied, this value is used in place of a randomly generated secret.
name	string <name> Generic strongbox name string, 1 to 1024 characters. Unique name of this TOTP credential within the tenant.
	to (object) or sites (object) or deployments (object) Default: "to" Selects how this object is distributed across sites.

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/strongbox/totp/{totp-name}

Request samples

Payload

name: admin
digits: 6
algorithm: sha1
key-size: 20
period: 30s
issuer: telco.com
account-name: admin@telco.com
skew: 1
passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
distribute:
  to: all

Delete a totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/strongbox/totp/{totp-name}

Replace or create a new totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

query Parameters

validate

string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"

Request Body schema:
application/yaml

One of:

digits	integer <uint16> Default: 6 Number of digits to enter as passcode.
algorithm	string <digest-type> Default: "sha1" `sha1` `sha224` `sha256` `sha384` `sha512` Digest types. sha1 is retained only for backward compatibility of existing configuration; it is broken for signatures and is floored to sha256 at signing time. Hash algorithm used to derive the TOTP code.
key-size	integer <uint16> Size of secret key. Default depends on algorithm sha1: 20 sha224: 32 sha256: 32 sha384: 64 sha512: 64
period	string <duration> Default: "30s" A duration in years, days, hours, minutes and seconds. Format is `[<digits>y][<digits>d][<digits>m][<digits>s]`. Examples: `1y2d5h`, `5h` or `10m30s` Re-generation period.
issuer	string Default: "unknown" The issuer parameter is a string value indicating the provider or service this account is associated with, URL-encoded according to RFC 3986. If the issuer parameter is absent it will default to `unknown`. The string may not contain colon.
account-name	string Default: "unknown" A unique name associated with the account. Typically the users email address is used. The string may not contain colon. The only purpose of this string is to help the end user associate the instance with the usage.
skew	integer <uint16> Default: 1 Number of periods before and after that are considered valid, ie a skew of 1 allows codes that were valid one period before and are valid one period after to be valid for the current period. This allows for some clock skew.
passcode32	string Optional pre-shared TOTP secret in base32 encoding. When supplied, this value is used in place of a randomly generated secret.
name	string <name> Generic strongbox name string, 1 to 1024 characters. Unique name of this TOTP credential within the tenant.
	to (object) or sites (object) or deployments (object) Default: "to" Selects how this object is distributed across sites.

Responses

201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/strongbox/totp/{totp-name}

Request samples

Payload

name: admin
digits: 6
algorithm: sha1
key-size: 20
period: 30s
issuer: telco.com
account-name: admin@telco.com
skew: 1
passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
distribute:
  to: all

Retrieve the configuration of a totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
where	string Retrieve only items matching the given expression. See section where
validate	string <enumeration> Validate the request but do not actually perform the requested operation Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/strongbox/totp/{totp-name}

Response samples

name: admin
digits: 6
algorithm: sha1
key-size: 20
period: 30s
issuer: telco.com
account-name: admin@telco.com
skew: 1
passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
distribute:
  to: all

Retrieve the state of all totps

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
where	string Retrieve only items matching the given expression. See section where
site	string Send the request to the specfifed site
content	string <enumeration> Filter descendant nodes in the response Enum: "config" "nonconfig"
keys	string <enumeration> Retrieve only the keys for the list Value: "true"
count	string <enumeration> Retrieve only the number of elements in the list Value: "true"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/strongbox/totp

Response samples

- name: admin
  digits: 6
  algorithm: sha1
  key-size: 20
  period: 30s
  issuer: telco.com
  account-name: admin@telco.com
  skew: 1
  passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
  url: otpauth://totp/Sbox:admin@telco.com?secret=34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X&issuer=telco.com
  creation-time: 2022-01-13T07:48:38.327935Z
  distribute:
    to: all
  distribution-status:
    to: all

Retrieve the state of a totp

TOTP (Time-based One-Time Password) entries. Each holds the shared secret and parameters used to generate or verify codes.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

query Parameters

fields	string Retrieve only requested fields from the resource See section fields
where	string Retrieve only items matching the given expression. See section where
site	string Send the request to the specfifed site
content	string <enumeration> Filter descendant nodes in the response Enum: "config" "nonconfig"

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/strongbox/totp/{totp-name}

Response samples

name: admin
digits: 6
algorithm: sha1
key-size: 20
period: 30s
issuer: telco.com
account-name: admin@telco.com
skew: 1
passcode32: 34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X
url: otpauth://totp/Sbox:admin@telco.com?secret=34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X&issuer=telco.com
creation-time: 2022-01-13T07:48:38.327935Z
distribute:
  to: all
distribution-status:
  to: all

Invoke the get-code operation

Generate a valid TOTP code.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/strongbox/totp/{totp-name}/get-code

Response samples

code: "677442"

Invoke the get-qr-code operation

Return base64 encoded QR-code in PNG format.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/strongbox/totp/{totp-name}/get-qr-code

Response samples

qr-code: iVBORw0KGgoAAAANSUhEUgAAAYgAAAGICAIAAADUIeBxAAAc90lEQVR4nO2aQbLr2q4j3/wn/atx3LhREbIEKSGQ3sg2AwCxZLb8v/8rpZRh/C8doJRS/n96mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMo4eplDKOHqZSyjh6mEop4+hhKqWMw36Y/reEVA9uHbdvqk8VNT+1LzU/Dc8r/acHu8ESUj24ddy+qT5V1PzUvtT8NDyv9J8e7AZLSPXg1nH7pvpUUfNT+1Lz0/C80n96sBssIdWDW8ftm+pTRc1P7UvNT8PzSv/pwW6whFQPbh23b6pPFTU/tS81Pw3PK/2nB7vBElI9uHXcvqk+VdT81L7U/DQ8r/SfHuwGS0j14NZx+6b6VFHzU/tS89PwvNJ/erAbLCHVg1vH7ZvqU0XNT+1LzU/D80r/6cFuEFrMnUfVoeZTvql5iutNfofypebdpPL0MA394I7mU76peYrrTX6H8qXm3aTy9DAN/eCO5lO+qXmK601+h/Kl5t2k8vQwDf3gjuZTvql5iutNfofypebdpPL0MA394I7mU76peYrrTX6H8qXm3aTy9DAN/eCO5lO+qXmK601+h/Kl5t2k8vQwDf3gjuZTvql5iutNfofypebdpPL0MA394I7mU76peYrrTX6H8qXm3aTyjDtM1z+R72zPQ+n/Ndz9uN+Lmk/loehhGpqH0v9ruPtxvxc1n8pD0cM0NA+l/9dw9+N+L2o+lYeih2loHkr/r+Hux/1e1HwqD0UP09A8lP5fw92P+72o+VQeih6moXko/b+Gux/3e1HzqTwUPUxD81D6fw13P+73ouZTeSh6mIbmofT/Gu5+3O9FzafyUPQwvZRH9XXnp/Z161BQ+af5Xm/4O+4eVNZ8EKmiqTyqrzs/ta9bh4LKP833esPfcfegsuaDSBVN5VF93fmpfd06FFT+ab7XG/6OuweVNR9Eqmgqj+rrzk/t69ahoPJP873e8HfcPais+SBSRVN5VF93fmpftw4FlX+a7/WGv+PuQWXNB5Eqmsqj+rrzU/u6dSio/NN8rzf8HXcPKms+iFTRVB7V152f2tetQ0Hln+Z7veHvuHtQWfNBpIqm8qi+7vzUvm4dCir/NN/rDX/H3YPKmg8iVXQqj6ozTV/VoVDzqP2obMlP5aHoYRqaR9WZpq/qUKh51H5UtuSn8lD0MA3No+pM01d1KNQ8aj8qW/JTeSh6mIbmUXWm6as6FGoetR+VLfmpPBQ9TEPzqDrT9FUdCjWP2o/KlvxUHooepqF5VJ1p+qoOhZpH7UdlS34qD0UP09A8qs40fVWHQs2j9qOyJT+Vh6KHaWgeVWeavqpDoeZR+1HZkp/KQzHuME3LQ+Wv7y6d7b4UqTw9TC99KPXdpbPdlyKVp4fppQ+lvrt0tvtSpPL0ML30odR3l852X4pUnh6mlz6U+u7S2e5LkcrTw/TSh1LfXTrbfSlSeXqYXvpQ6rtLZ7svRSpPD9NLH0p9d+ls96VI5Ykdpmmo+Tvf+Tfnp3GUn6KH6YOav/Odf3N+Gkf5KXqYPqj5O9/5N+encZSfoofpg5q/851/c34aR/kpepg+qPk73/k356dxlJ+ih+mDmr/znX9zfhpH+Sl6mD6o+Tvf+Tfnp3GUn6KH6YOav/Odf3N+Gkf5KewG21EfhnrI1Aeh5lFJ5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu7Rgk5QPyzqQ5z2QV8/Pd9J5U/RHu4R+4OlOu+G2kvVd+tQ89Nw90xB7TUtp5seppM8VM6UDjU/DXfPFNRe03K66WE6yUPlTOlQ89Nw90xB7TUtp5seppM8VM6UDjU/DXfPFNRe03K66WE6yUPlTOlQ89Nw90xB7TUtp5seppM8VM6UDjU/DXfPFNRe03K66WE6yUPlTOlQ89Nw90xB7TUtp5seppM8VM6UDjU/DXfPFNRe03K6GXeYUqRyej6zPNS+2/tXfbfnpOhh+hB7gB+F2nd7/6rv9pwUPUwfYg/wo1D7bu9f9d2ek6KH6UPsAX4Uat/t/au+23NS9DB9iD3Aj0Ltu71/1Xd7Tooepg+xB/hRqH2396/6bs9J0cP0IfYAPwq17/b+Vd/tOSl6mD7EHuBHofbd3r/quz0nRexAUMVR+rEHWAKVf1qfqo47P5WH6iHFuKKp4lT91INROd1Q+af1qeq481N5qB5SjCuaKk7VTz0YldMNlX9an6qOOz+Vh+ohxbiiqeJU/dSDUTndUPmn9anquPNTeageUowrmipO1U89GJXTDZV/Wp+qjjs/lYfqIcW4oqniVP3Ug1E53VD5p/Wp6rjzU3moHlKMK5oqTtVPPRiV0w2Vf1qfqo47P5WH6iHFuKKp4lT91INROd1Q+af1qeq481N5qB5SjPtQUoVO803pUL5qHncPVE53fso3lYdiXHGpoqf5pnQoXzWPuwcqpzs/5ZvKQzGuuFTR03xTOpSvmsfdA5XTnZ/yTeWhGFdcquhpvikdylfN4+6ByunOT/mm8lCMKy5V9DTflA7lq+Zx90DldOenfFN5KMYVlyp6mm9Kh/JV87h7oHK681O+qTwU44pLFT3NN6VD+ap53D1QOd35Kd9UHopxxaWKnuab0qF81TzuHqic7vyUbyoPxZqgFO4PkfpQqHlVJ5Vniz4174bqIcW4QG6oh1EfXvWl5lWdVJ4t+tS8G6qHFOMCuaEeRn141ZeaV3VSebboU/NuqB5SjAvkhnoY9eFVX2pe1Unl2aJPzbuhekgxLpAb6mHUh1d9qXlVJ5Vniz4174bqIcW4QG6oh1EfXvWl5lWdVJ4t+tS8G6qHFOMCuaEeRn141ZeaV3VSebboU/NuqB5SjAvkhnoY9eFVX2pe1Unl2aJPzbuhekix5g9g0+ZVKH13Tnee1DxFKqdbZxo9TDfnVSh9d053ntQ8RSqnW2caPUw351UofXdOd57UPEUqp1tnGj1MN+dVKH13Tnee1DxFKqdbZxo9TDfnVSh9d053ntQ8RSqnW2caPUw351UofXdOd57UPEUqp1tnGj1MN+dVKH13Tnee1DxFKqdbZxo9TDfnVSh9d053ntQ8RSqnW2cascPk1qeg9lLnqR7UeZXUvinfVA9b+qf42Q+FgtpLnad6UOdVUvumfFM9bOmf4mc/FApqL3We6kGdV0ntm/JN9bClf4qf/VAoqL3UeaoHdV4ltW/KN9XDlv4pfvZDoaD2UuepHtR5ldS+Kd9UD1v6p/jZD4WC2kudp3pQ51VS+6Z8Uz1s6Z/iZz8UCmovdZ7qQZ1XSe2b8k31sKV/ip/9UCiovdR5qgd1XiW1b8o31cOW/inWfChHOu4HSD2w6pvqgSLVAzWvcr35mT24GfcDU3XchaYeTPVN9UCR6oGaV7ne/Mwe3Iz7gak67kJTD6b6pnqgSPVAzatcb35mD27G/cBUHXehqQdTfVM9UKR6oOZVrjc/swc3435gqo670NSDqb6pHihSPVDzKtebn9mDm3E/MFXHXWjqwVTfVA8UqR6oeZXrzc/swc24H5iq4y409WCqb6oHilQP1LzK9eZn9uBm3A9M1XEXmnow1TfVA0WqB2pe5XrzM3twE/uBqUzTp/K4+3TvpeZ3k9rr+ouw+tNyUvQw3dSn8rj7dO+l5neT2uv6i7D603JS9DDd1KfyuPt076Xmd5Pa6/qLsPrTclL0MN3Up/K4+3TvpeZ3k9rr+ouw+tNyUvQw3dSn8rj7dO+l5neT2uv6i7D603JS9DDd1KfyuPt076Xmd5Pa6/qLsPrTclL0MN3Up/K4+3TvpeZ3k9rr+ouw+tNyUvQw3dSn8rj7dO+l5neT2uv6i7D603JSrP+joLtQKo8KlZPypfTdqL25UXOmenDry3nsBuJi7vlUfhUqJ+VL6btRe3Oj5kz14NaX89gNxMXc86n8KlROypfSd6P25kbNmerBrS/nsRuIi7nnU/lVqJyUL6XvRu3NjZoz1YNbX85jNxAXc8+n8qtQOSlfSt+N2psbNWeqB7e+nMduIC7mnk/lV6FyUr6Uvhu1NzdqzlQPbn05j91AXMw9n8qvQuWkfCl9N2pvbtScqR7c+nIeu4G4mHs+lV+Fykn5Uvpu1N7cqDlTPbj15Tx2A2hhVYfC3Y/Kln1T+imoHqblSdHDdDNPii37pvRTUD1My5Oih+lmnhRb9k3pp6B6mJYnRQ/TzTwptuyb0k9B9TAtT4oeppt5UmzZN6WfguphWp4UPUw386TYsm9KPwXVw7Q8KXqYbuZJsWXflH4KqodpeVL0MN3Mk2LLvin9FFQP0/KkWPMHS+phUvmpfan8W6B6noa7h+199jC9lJ/al8q/Barnabh72N5nD9NL+al9qfxboHqehruH7X32ML2Un9qXyr8FqudpuHvY3mcP00v5qX2p/Fugep6Gu4ftffYwvZSf2pfKvwWq52m4e9jeZw/TS/mpfan8W6B6noa7h+199jC9lJ/al8q/Barnabh72N7n+od061DzKupeKabtRfWfyl/+saZo6kNRdah5FXWvFNP2ovpP5S//WFM09aGoOtS8irpXiml7Uf2n8pd/rCma+lBUHWpeRd0rxbS9qP5T+cs/1hRNfSiqDjWvou6VYtpeVP+p/OUfa4qmPhRVh5pXUfdKMW0vqv9U/vKPNUVTH4qqQ82rqHulmLYX1X8qf/nHmqKpD0XVoeZV1L1STNuL6j+Vv/wj9wcq8weR+rCeffZzoXpO5ex7sT2o+nIet8Ghcahoxy5XfLdD9ZzK2fdie1D15Txug0PjUNGOXa74bofqOZWz78X2oOrLedwGh8ahoh27XPHdDtVzKmffi+1B1ZfzuA0OjUNFO3a54rsdqudUzr4X24OqL+dxGxwah4p27HLFdztUz6mcfS+2B1VfzuM2ODQOFe3Y5YrvdqieUzn7XmwPqr6cx21waBwq2rHLFd/tUD2ncva92B5UfTmP24Ai9QCpB9ui786p+rpJ5VT1qfkU4wIdQRX69AM5Y9q+bn13TtXXTSqnqk/NpxgX6Aiq0KcfyBnT9nXru3Oqvm5SOVV9aj7FuEBHUIU+/UDOmLavW9+dU/V1k8qp6lPzKcYFOoIq9OkHcsa0fd367pyqr5tUTlWfmk8xLtARVKFPP5Azpu3r1nfnVH3dpHKq+tR8inGBjqAKffqBnDFtX7e+O6fq6yaVU9Wn5lOMC3QEVejTD+SMafu69d05VV83qZyqPjWfIvYBUfNuXwo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfHqaTeQo1PwXVQ8o3lV/FnZ/SV32ftXKfcX+sUkk9PPWQlE5K352HmqegfFO9UTpqfpUeJhh3/mn67jzUPAXlm+qN0lHzq/QwwbjzT9N356HmKSjfVG+UjppfpYcJxp1/mr47DzVPQfmmeqN01PwqPUww7vzT9N15qHkKyjfVG6Wj5lfpYYJx55+m785DzVNQvqneKB01v0oPE4w7/zR9dx5qnoLyTfVG6aj5VXqYYNz5p+m781DzFJRvqjdKR82vMu4DpUjlnOZLzVNQOd37bvel8lA55b3cBofGZlI5p/lS8xRUTve+232pPFROeS+3waGxmVTOab7UPAWV073vdl8qD5VT3sttcGhsJpVzmi81T0HldO+73ZfKQ+WU93IbHBqbSeWc5kvNU1A53ftu96XyUDnlvdwGh8ZmUjmn+VLzFFRO977bfak8VE55L7fBobGZVM5pvtQ8BZXTve92XyoPlVPey21waGwmlXOaLzVPQeV077vdl8pD5ZT3chuoTHuwLTmn7UXpU/Nu3P2k8qQYtwBVtPshp+WcthelT827cfeTypNi3AJU0e6HnJZz2l6UPjXvxt1PKk+KcQtQRbsfclrOaXtR+tS8G3c/qTwpxi1AFe1+yGk5p+1F6VPzbtz9pPKkGLcAVbT7IaflnLYXpU/Nu3H3k8qTYtwCVNHuh5yWc9pelD4178bdTypPinELUEW7H3Jazml7UfrUvBt3P6k8KfYvMOzBUnm279ve2H5Se1GsCXrEtIdJ5dm+b3tj+0ntRbEm6BHTHiaVZ/u+7Y3tJ7UXxZqgR0x7mFSe7fu2N7af1F4Ua4IeMe1hUnm279ve2H5Se1GsCXrEtIdJ5dm+b3tj+0ntRbEm6BHTHiaVZ/u+7Y3tJ7UXxZqgR0x7mFSe7fu2N7af1F4Uax7AnYfCvZdbh9orpa/2oPpS825SvVH0MMG493LrUHul9NUeVF9q3k2qN4oeJhj3Xm4daq+UvtqD6kvNu0n1RtHDBOPey61D7ZXSV3tQfal5N6neKHqYYNx7uXWovVL6ag+qLzXvJtUbRQ8TjHsvtw61V0pf7UH1pebdpHqj6GGCce/l1qH2SumrPai+1LybVG8UPUww7r3cOtReKX21B9WXmneT6o1izR/wVP1UTmqeQu2BIpWT8lV1tkP1T9HDBOek5inUHihSOSlfVWc7VP8UPUxwTmqeQu2BIpWT8lV1tkP1T9HDBOek5inUHihSOSlfVWc7VP8UPUxwTmqeQu2BIpWT8lV1tkP1T9HDBOek5inUHihSOSlfVWc7VP8UPUxwTmqeQu2BIpWT8lV1tkP1T9HDBOek5inUHihSOSlfVWc7VP8U6/9gSc2rPO0lnYfSn5Zn2r7u/KrOFnqYbvK0l3QeSn9anmn7uvOrOlvoYbrJ017SeSj9aXmm7evOr+psoYfpJk97Seeh9KflmbavO7+qs4Uepps87SWdh9Kflmfavu78qs4Wephu8rSXdB5Kf1qeafu686s6W+hhusnTXtJ5KP1peabt686v6myhh+kmT3tJ56H0p+WZtq87v6qzhXGHKeU77YNz66s6bt9Un27fafu696IY94GmfN3zqo5bX9Vx+6b6dPtO29e9F8W4DzTl655Xddz6qo7bN9Wn23favu69KMZ9oClf97yq49ZXddy+qT7dvtP2de9FMe4DTfm651Udt76q4/ZN9en2nbavey+KcR9oytc9r+q49VUdt2+qT7fvtH3de1GM+0BTvu55Vcetr+q4fVN9un2n7evei2LcB5rydc+rOm59Vcftm+rT7TttX/deFOs/UPVhVLb4UjmPdFSebX8/j3svKo8bNc+bnVyhh+mELb5UziMdlWfb38/j3ovK40bN82YnV+hhOmGLL5XzSEfl2fb387j3ovK4UfO82ckVephO2OJL5TzSUXm2/f087r2oPG7UPG92coUephO2+FI5j3RUnm1/P497LyqPGzXPm51coYfphC2+VM4jHZVn29/P496LyuNGzfNmJ1foYTphiy+V80hH5dn29/O496LyuFHzvNnJFXqYTtjiS+U80lF5tv39PO69qDxu1DxvdnKFcYGmQT389g+L8k31M41nr3G+7xb9Q1+3wXbUh3n6wd7V92zP+6b6mcaz1zjfd4v+oa/bYDvqwzz9YO/qe7bnfVP9TOPZa5zvu0X/0NdtsB31YZ5+sHf1Pdvzvql+pvHsNc733aJ/6Os22I76ME8/2Lv6nu1531Q/03j2Guf7btE/9HUbbEd9mKcf7F19z/a8b6qfaTx7jfN9t+gf+roNtqM+zNMP9q6+Z3veN9XPNJ69xvm+W/QPfd0G21Ef5ukHe1ffsz3vm+pnGs9e43zfLfqHvnaDJbh7oPpJ6bj3dedR+3H7bplP0cP0wd0D1U9Kx72vO4/aj9t3y3yKHqYP7h6oflI67n3dedR+3L5b5lP0MH1w90D1k9Jx7+vOo/bj9t0yn6KH6YO7B6qflI57X3cetR+375b5FD1MH9w9UP2kdNz7uvOo/bh9t8yn6GH64O6B6iel497XnUftx+27ZT5FD9MHdw9UPykd977uPGo/bt8t8ynW/DEvlYfKn9KZ1r+b1L5Hvu48lG+qt8M8doNpC4ceLKUzrX83qX2PfN15KN9Ub4d57AbTFg49WEpnWv9uUvse+brzUL6p3g7z2A2mLRx6sJTOtP7dpPY98nXnoXxTvR3msRtMWzj0YCmdaf27Se175OvOQ/mmejvMYzeYtnDowVI60/p3k9r3yNedh/JN9XaYx24wbeHQg6V0pvXvJrXvka87D+Wb6u0wj91g2sKhB0vpTOvfTWrfI193Hso31dthHrsBVFDqAdx53L5qnmk6Kaicag8UqX0pepjCedy+ap5pOimonGoPFKl9KXqYwnncvmqeaTopqJxqDxSpfSl6mMJ53L5qnmk6Kaicag8UqX0pepjCedy+ap5pOimonGoPFKl9KXqYwnncvmqeaTopqJxqDxSpfSl6mMJ53L5qnmk6Kaicag8UqX0pepjCedy+ap5pOimonGoPFKl9KXqY4Hm3zjTc70LpbJmnuN7kO3lUepjgebfONNzvQulsmae43uQ7eVR6mOB5t8403O9C6WyZp7je5Dt5VHqY4Hm3zjTc70LpbJmnuN7kO3lUepjgebfONNzvQulsmae43uQ7eVR6mOB5t8403O9C6WyZp7je5Dt5VHqY4Hm3zjTc70LpbJmnuN7kO3lUepjgebfONNzvQulsmae43uQ7eVR6mF6aV3VUpuX8a/tSvm6ovdz0ML00r+qoTMv51/alfN1Qe7npYXppXtVRmZbzr+1L+bqh9nLTw/TSvKqjMi3nX9uX8nVD7eWmh+mleVVHZVrOv7Yv5euG2stND9NL86qOyrScf21fytcNtZebHqaX5lUdlWk5/9q+lK8bai83PUwvzas6KtNy/rV9KV831F5uxh2mX83j/rB+VUdF9aX2SvWQ2stND9NLedQPSM35qzoqqi+1V6qH1F5uepheyqN+QGrOX9VRUX2pvVI9pPZy08P0Uh71A1Jz/qqOiupL7ZXqIbWXmx6ml/KoH5Ca81d1VFRfaq9UD6m93PQwvZRH/YDUnL+qo6L6Unulekjt5aaH6aU86gek5vxVHRXVl9or1UNqLzc9TC/lUT8gNeev6qiovtReqR5Se7lZ84N0Q+Wn+nHnUXVUfbcvhftdqH7cfao53fQwfaDyU/2486g6qr7bl8L9LlQ/7j7VnG56mD5Q+al+3HlUHVXf7UvhfheqH3efak43PUwfqPxUP+48qo6q7/alcL8L1Y+7TzWnmx6mD1R+qh93HlVH1Xf7UrjfherH3aea000P0wcqP9WPO4+qo+q7fSnc70L14+5Tzemmh+kDlZ/qx51H1VH13b4U7neh+nH3qeZ008P0gcpP9ePOo+qo+m5fCve7UP24+1RzuhkXqJRSephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjh6mUso4ephKKePoYSqljKOHqZQyjv8H01ebrCT9jN0AAAAASUVORK5CYII=
url: otpauth://totp/Sbox:admin@telco.com?secret=34XVZAVKQ7PRBE3KJQWHYKC3EAT75I2X&issuer=telco.com

Invoke the verify-code operation

Verify a code against TOTP specification.

SecurityaccessToken

Request

path Parameters

totp-name

required

string <name>

Unique name of this TOTP credential within the tenant.

Request Body schema:
application/yaml

code

required

string

TOTP code to verify.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/strongbox/totp/{totp-name}/verify-code

Request samples

Payload

code: "677442"

Response samples

valid: true

➔ Next to Transform Data

TOTP

Create a new totp

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of all totps

query Parameters

Update a totp

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Delete a totp

path Parameters

query Parameters

Replace or create a new totp

path Parameters

query Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Retrieve the configuration of a totp

path Parameters

query Parameters

Retrieve the state of all totps

query Parameters

Retrieve the state of a totp

path Parameters

query Parameters

Invoke the get-code operation

path Parameters

Invoke the get-qr-code operation

path Parameters

Invoke the verify-code operation

path Parameters

Request Body schema: application/yamlapplication/jsonapplication/yaml

Request Body schema:
application/yaml

Request Body schema:
application/yaml

Request Body schema:
application/yaml

Request Body schema:
application/yaml