signUpEmailPassword

curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/signup/email-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "Str0ngPassw#ord-94|%",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}
'

{
  "session": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "accessTokenExpiresIn": 900,
    "refreshTokenId": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "user": {
      "avatarUrl": "https://myapp.com/avatars/user123.jpg",
      "createdAt": "2023-01-15T12:34:56Z",
      "defaultRole": "user",
      "displayName": "John Smith",
      "emailVerified": true,
      "id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
      "isAnonymous": false,
      "locale": "en",
      "metadata": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "phoneNumberVerified": false,
      "roles": [
        "user",
        "customer"
      ],
      "email": "[email protected]",
      "phoneNumber": "+12025550123",
      "activeMfaType": "<string>"
    }
  }
}

POST

signup

email-password

curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/signup/email-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "Str0ngPassw#ord-94|%",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}
'

{
  "session": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "accessTokenExpiresIn": 900,
    "refreshTokenId": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "user": {
      "avatarUrl": "https://myapp.com/avatars/user123.jpg",
      "createdAt": "2023-01-15T12:34:56Z",
      "defaultRole": "user",
      "displayName": "John Smith",
      "emailVerified": true,
      "id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
      "isAnonymous": false,
      "locale": "en",
      "metadata": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "phoneNumberVerified": false,
      "roles": [
        "user",
        "customer"
      ],
      "email": "[email protected]",
      "phoneNumber": "+12025550123",
      "activeMfaType": "<string>"
    }
  }
}

Body

application/json

User registration information including email, password, and optional profile data

Request to register a new user with email and password

string<email>

required

Email address for the new user account

Example:

"[email protected]"

password

string

required

Password for the new user account

Required string length: 3 - 50

Example:

"Str0ngPassw#ord-94|%"

options

object

Show child attributes

options.allowedRoles

string[]

Example:

["me", "user"]

options.defaultRole

string

Example:

"user"

options.displayName

string

Maximum string length: 32

Example:

"John Smith"

options.locale

string

A two-characters locale

Required string length: 2

Example:

"en"

options.metadata

object

Example:

{ "firstName": "John", "lastName": "Smith" }

options.redirectTo

string<uri>

Example:

"https://my-app.com/catch-redirection"

Response

Registration successful. If email verification is required, session will be null.

Container for session information

session

object

User authentication session containing tokens and user information

Show child attributes

session.accessToken

string

required

JWT token for authenticating API requests

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

session.accessTokenExpiresIn

integer<int64>

required

Expiration time of the access token in seconds

Example:

900

session.refreshTokenId

string

required

Identifier for the refresh token

Example:

"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"

session.refreshToken

string

required

Token used to refresh the access token

Example:

"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"

session.user

object

User profile and account information

Show child attributes

session.user.avatarUrl

string

required

URL to the user's profile picture

Example:

"https://myapp.com/avatars/user123.jpg"

session.user.createdAt

string<date-time>

required

Timestamp when the user account was created

Example:

"2023-01-15T12:34:56Z"

session.user.defaultRole

string

required

Default authorization role for the user

Example:

"user"

session.user.displayName

string

required

User's display name

Example:

"John Smith"

session.user.emailVerified

boolean

required

Whether the user's email has been verified

Example:

true

session.user.id

string

required

Unique identifier for the user

Example:

"2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24"

session.user.isAnonymous

boolean

required

Whether this is an anonymous user account

Example:

false

session.user.locale

string

required

User's preferred locale (language code)

Required string length: 2

Example:

"en"

session.user.metadata

object

required

Custom metadata associated with the user

Example:

{ "firstName": "John", "lastName": "Smith" }

session.user.phoneNumberVerified

boolean

required

Whether the user's phone number has been verified

Example:

false

session.user.roles

string[]

required

List of roles assigned to the user

Example:

["user", "customer"]

session.user.email

string<email>

User's email address

Example:

"[email protected]"

session.user.phoneNumber

string

User's phone number

Example:

"+12025550123"

session.user.activeMfaType

string | null

Active MFA type for the user

/signout /signup/webauthn

⌘I

Backend Services

Client Libraries

Client Libraries (deprecated)

CLI

Body

Response