User

Set TOTP MFA key

Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey.

post/api/user/mfa/totp/set-key

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
- API key in header x-api-key
- or API key in cookie jwt
- or API key in header x-jwt-token
- or OAuth 2
  Authorization code/v1/oauth/authorize
  Client credentials
  Implicit/v1/oauth/authorize
  Password
  Token URL/v1/oauth/token
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/user/mfa/totp/set-key/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

keystring required

Secret key obtained through userGenerateNewMfaKey.

totpTokenstring required

TOTP token that is valid for the key (to ensure the device is configured correctly)

Response

successboolean required

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

recoveryCodesstring[] required

10 recovery codes, which can be used in case you've lost access to your MFA TOTP app. Recovery codes are single use. Once you've used a recovery code once, it can not be used again.

Changes

No recorded changes to this operation across all 1 revision of this API.

Set TOTP MFA key

Request

Request body

Response 200OK

Changes

Response