Sets the actor's preferred OTP type in his MFA config

Error

A valid request URL is required to generate request examples

{
  "item": "sms"
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

PUT

auth

mfa

preferredType

Error

A valid request URL is required to generate request examples

{
  "item": "sms"
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

application/json

Type of OTP (One-Time Password).

Available options:

none,

email,

sms,

totp

Example:

"sms"

The actor's MFA config preferred OTP type was set.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

item

enum<string>

default:none