User Registration

POST /signup

This endpoint allows you to register an authenticated user in our local database. The user's details should be provided in the request payload. Upon successful registration, the user will be added to the local database, allowing for subsequent interactions with the app.

Headers

Name
Value

Content-Type

application/json

Body

Name
Type
Description

uid

String

Unique identifier for the user

email

String

Email address of the user

displayName

String

Display name of the user

emailVerified

Boolean

Indicates if the email is verified

createdAt

DateTime

Account creation date and time (ISO 8601)

lastLoginAt

DateTime

Last login date and time (ISO 8601)

providerData

Array

Array of provider data objects

├─ providerId

String

Identifier for the authentication provider

└─ providerName

String

Name of the authentication provider

providerUsername

String

Username provided by the authentication provider

Sample Request

curl -X POST https://server-ip:port/signup \
-H "Content-Type: application/json" \
-H "Authorization: Bearer {token}" \
-d '{
  "uid": "12345",
  "email": "testaccount@gmail.com",
  "displayName": "Sample User",
  "emailVerified": true,
  "createdAt": "2024-06-19T12:34:56Z",
  "lastLoginAt": "2024-06-19T12:34:56Z",
  "providerData": [
    {
      "providerId": "google.com",
      "providerName": "Google"
    }
  ],
  "providerUsername": "testaccount"
}'

Response

{
  "uid": "12345",
}

By following the above guidelines, you can seamlessly register users in the local database and proceed with further interactions within the app.

Last updated