1. Docs
  2. API Reference
  3. OAuth hosted login: self-signup form submission

OAuth hosted login: self-signup form submission

POST/oauth/register

Hosted self-signup submission. The underlying register call hard-gates on allow_self_signup, self_signup_require_captcha, the daily signup cap, and the origin check, and is anti-enumeration. On success the new identity is unverified, so the login page is rendered with a "check your email" notice and the OAuth parameters preserved; a gate failure re-renders the signup form with the error. Throttled to 10 requests per 15 minutes.

Request body

application/json

emailstring Required

Identity email address

passwordstring Required

Password for the new identity

first_namestring Optional

First name

last_namestring Optional

Last name

client_idstring Required
redirect_uristring Required
response_typestring Required
scopestring Required
statestring Required
code_challengestring Required
code_challenge_methodstring Required
noncestring Optional
captcha_tokenstring Optional

The solved CAPTCHA, posted by the widget on the form when the Environment requires one.

Responses

text/html

string

application/json

  • errorApiErrorBodyDto*

text/html

string

application/json

  • errorApiErrorBodyDto*

Rate limit

10 requests per 15mPer caller: the signed-in user for a bearer token; for an API key, the key and the end user's address when a backend forwards it, otherwise the client address
Request
curl -X POST "https://auth.canopy-io.com/oauth/register" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "password": "string",
    "first_name": "string",
    "last_name": "string",
    "client_id": "string",
    "redirect_uri": "string",
    "response_type": "string",
    "scope": "string",
    "state": "string",
    "code_challenge": "string",
    "code_challenge_method": "string",
    "nonce": "string",
    "captcha_token": "string"
  }'
Response
Content-Type: text/html

<!doctype html>
<html lang="en">
  <head>…</head>
  <body>
    <!-- The hosted page: its form, any error, and the Environment's branding -->
  </body>
</html>
 Related endpoints Was this page helpful?

Tell us how we can improve this guide.

Canopy