Show TOTP Setup Details

GET /api/v1/me/otp/show

Show the setup QRCode, URL and a base32 encoded secret to set up an TOTP based authenticator application.

Headers

Authorization string
Content-Type string
Accept string

Responses

200 application/json
Hide response attributes Show response attributes object
- otp_setup_image string
  
  The TOTP QRCode set-up image in RAW SVG format.
- otp_setup_url string
  
  The TOTP URL encoded in the QRCode image.
- otp_secret string
  
  The TOTP secret key in base32 format.

GET /api/v1/me/otp/show

curl \
 -X GET https://api.plannrcrm.com/api/v1/me/otp/show \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"

Response examples (200)

{
  "otp_secret": "AE72QGEJNNNJKHXW",
  "otp_setup_url": "otpauth://totp/Codepotato%20%28Plannr%20CRM%29:gareth%40codepotato.co.uk?secret=AE72QGEJNNNJKHXW&issuer=Codepotato%20%28Plannr%20CRM%29&algorithm=SHA1&digits=6&period=30",
  "otp_setup_image": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><svg>...</svg>"
}