Skip to main content
POST
/
auth
/
signup
Sign Up
curl --request POST \
  --url https://api.example.com/auth/signup \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "password": "<string>",
  "name": "<string>"
}
'
{
  "message": "<string>",
  "user": {},
  "accessToken": "<string>",
  "idToken": "<string>",
  "refreshToken": "<string>",
  "expiresIn": 123,
  "tokenType": "Bearer"
}

Body

application/json

Request model for user sign up.

email
string<email>
required

User email address

password
string
required

User password

Minimum string length: 6
name
string | null

User display name

Response

Successful Response

Response model for successful sign up.

message
string
required

Success message

user
User · object
required

Created user information

accessToken
string
required

Access token for API requests

idToken
string
required

ID token with user claims

refreshToken
string
required

Refresh token for token renewal

expiresIn
integer
required

Token expiry time in seconds

tokenType
string
default:Bearer

Token type