Start two-factor setup

Error

A valid request URL is required to generate request examples

{
  "secret": "<string>",
  "otpauth_url": "<string>",
  "qr_data_uri": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

POST

account

two-factor

setup

Error

A valid request URL is required to generate request examples

{
  "secret": "<string>",
  "otpauth_url": "<string>",
  "qr_data_uri": "<string>"
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Authorization

string

header

required

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

The secret to scan or type.

secret

string

Plaintext, shown once — what someone types when they cannot scan.

otpauth_url

string

qr_data_uri

string

A PNG data URI.

⌘I