Auth

Register a new user

POST

http://localhost:3000/api/auth/register

curl -X POST 'http://localhost:3000/api/auth/register' \
  -H 'origin: string' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "password": "string",
  "confirmPassword": "string",
  "user": {
    "email": "string",
    "roleId": "string",
    "role": {},
    "firstName": "string",
    "lastName": "string",
    "imageUrl": "string",
    "preferredLanguage": "en"
  },
  "organizationId": "string",
  "createdByUserId": "string",
  "featureAsEmployee": true,
  "terms": [
    {
      "documentId": "tos:gauzy",
      "version": "1.0.0",
      "sha256": "string",
      "locale": "en"
    }
  ],
  "stripeCheckoutSessionId": "string"
}'

const body = `{
  "password": "string",
  "confirmPassword": "string",
  "user": {
    "email": "string",
    "roleId": "string",
    "role": {},
    "firstName": "string",
    "lastName": "string",
    "imageUrl": "string",
    "preferredLanguage": "en"
  },
  "organizationId": "string",
  "createdByUserId": "string",
  "featureAsEmployee": true,
  "terms": [
    {
      "documentId": "tos:gauzy",
      "version": "1.0.0",
      "sha256": "string",
      "locale": "en"
    }
  ],
  "stripeCheckoutSessionId": "string"
}`;

const response = await fetch('http://localhost:3000/api/auth/register', {
  method: 'POST',
  headers: {
    'origin': 'string',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "password": "string",
  "confirmPassword": "string",
  "user": {
    "email": "string",
    "roleId": "string",
    "role": {},
    "firstName": "string",
    "lastName": "string",
    "imageUrl": "string",
    "preferredLanguage": "en"
  },
  "organizationId": "string",
  "createdByUserId": "string",
  "featureAsEmployee": true,
  "terms": [
    {
      "documentId": "tos:gauzy",
      "version": "1.0.0",
      "sha256": "string",
      "locale": "en"
    }
  ],
  "stripeCheckoutSessionId": "string"
}'''

response = requests.post(
    'http://localhost:3000/api/auth/register',
    data=body.encode('utf-8'),
    headers={
        'origin': 'string',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "password": "string",
  "confirmPassword": "string",
  "user": {
    "email": "string",
    "roleId": "string",
    "role": {},
    "firstName": "string",
    "lastName": "string",
    "imageUrl": "string",
    "preferredLanguage": "en"
  },
  "organizationId": "string",
  "createdByUserId": "string",
  "featureAsEmployee": true,
  "terms": [
    {
      "documentId": "tos:gauzy",
      "version": "1.0.0",
      "sha256": "string",
      "locale": "en"
    }
  ],
  "stripeCheckoutSessionId": "string"
}

Body

application/json

passwordstringrequired

confirmPasswordstringrequired

userCreateUserDTOrequired

Show child attributes

emailstringrequired

roleIdstring

roleobject

Role reference: an object with the role id (UUID).

firstNamestring

lastNamestring

imageUrlstring

preferredLanguagestringenbgherufreszhdeptitnlplar

organizationIdstring

createdByUserIdstring

featureAsEmployeeboolean

termsArray<TermsAcceptanceClaimDTO>

Show child attributes

documentIdstringrequired

Example

tos:gauzy

versionstringrequired

Example

1.0.0

sha256stringrequired

Lowercase hex sha256 of the document source.

localestringrequired

Example

en

stripeCheckoutSessionIdstring

Stripe Checkout Session id (cs_live_... / cs_test_...)

Parameters

originstringrequiredheader

Response

201Created

The record has been successfully created.

400Bad Request

Invalid input, the response body may contain clues as to what went wrong

Stack Overflow Website Demo