1. Docs
  2. API Reference
  3. OAuth hosted login: email a passwordless login code

OAuth hosted login: email a passwordless login code

POST/oauth/login/email-otp/start

Step 1 of the hosted passwordless email-OTP login: emails a one-time login code for the supplied email. Gated per-Environment on email_otp_login_enabled and (when enabled) login_require_captcha verification of cf-turnstile-response. Anti-enumeration — always renders a generic "code sent" page whether or not the identity exists; only a disabled-method or failed-CAPTCHA case re-renders the form with an error. Throttled to 5 requests per 15 minutes.

Request body

application/json

emailstring Required
client_idstring Required
redirect_uristring Required
response_typestring Required
scopestring Required
statestring Optional
code_challengestring Required
code_challenge_methodstring Required

Responses

200
Request
curl -X POST "https://auth.canopy-io.com/oauth/login/email-otp/start" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "client_id": "string",
    "redirect_uri": "string",
    "response_type": "string",
    "scope": "string",
    "state": "string",
    "code_challenge": "string",
    "code_challenge_method": "string"
  }'
Response
HTTP/1.1 200

(empty body)
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy