user

Register User

Register a new user with email verification (local or SSO).

Accepts either:

  • 3-word verification code for local users
  • SSO JWT token for SSO users

Auto-detects credential type and handles both flows.

post/api/user/register

Request body

emailstring email required
signing_keystring required
verification_credentialstring required
given_namestring nullable
family_namestring nullable
picturestring nullable

Response

Successful Response

{"stackTrail":"paths:/api/user/register:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 3 of the 34 revisions of this API.5107

  • aa4b06f8dede133See the full diff
    • added the new required request property signing_key

      new-required-request-property

    • removed the request property last_name

      request-property-removed

    • removed the request property name

      request-property-removed

    • removed the request property public_key

      request-property-removed

    • added the new optional request property family_name

      new-optional-request-property

    • added the new optional request property given_name

      new-optional-request-property

    • added the new optional request property picture

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 849d5e8732f6374See the full diff
    • added the new required request property public_key

      new-required-request-property

    • added the new required request property verification_credential

      new-required-request-property

    • the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • removed the request property password

      request-property-removed

    • removed the request property verification_code

      request-property-removed

    • removed the optional property email from the response with the 200 status

      response-optional-property-removed

    • removed the optional property external_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property last_name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property public_key from the response with the 200 status

      response-optional-property-removed

    • the request property last_name became optional

      request-property-became-optional

    • the request property name became optional

      request-property-became-optional

    • request property last_name list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • request property name list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new required request property verification_code

      new-required-request-property