Email and Password
Sign Up
- Documentation
- Community
- Blog
- Overview
Authentication
Email and Password
Passwordless
OAuth
WebAuthn
Anonymous
MFA
User
- POSTSign Out
Storage
AI
JavaScript
React
Next.js
Vue
API Documentation
Backend Services
GraphQL
Client Libraries
Email and Password
Sign Up
POST
/
signup
/
email-password
object
*
email
string
*
email
Required
string
A valid email
Add Example Value
password
string
*
password
Required
string
A password of minimum 9 characters
Add Example Value
options
object
options
object
allowedRoles
array
allowedRoles
array
Add Example Value
defaultRole
enum<string>
defaultRole
enum<string>
Add Example Value
displayName
string
displayName
string
Add Example Value
locale
string
locale
string
A two-characters locale
Add Example Value
metadata
object
metadata
object
Add Example Value
redirectTo
string
redirectTo
string
Add Example Value
curl --request POST \
--url https://local.auth.nhost.run/v1/signup/email-password \
--header 'Content-Type: application/json' \
--data '{
"email": "john.smith@nhost.io",
"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"
}
}'
{
"mfa": {
"ticket": "<string>"
},
"session": {
"accessToken": "<string>",
"accessTokenExpiresIn": 123,
"refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"user": {
"activeMfaType": "totp",
"avatarUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultRole": "user",
"displayName": "John Smith",
"email": "john.smith@nhost.io",
"emailVerified": true,
"id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"isAnonymous": true,
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"phoneNumber": "<string>",
"phoneNumberVerified": true,
"roles": [
"me",
"user"
]
}
}
}
Body
application/json
email
string
requiredA valid email
password
string
requiredA password of minimum 9 characters
options
object
options.allowedRoles
enum<string>[]
Available options:
me
options.defaultRole
enum<string>
default: userAvailable options:
me
, user
options.displayName
string
options.locale
string
default: enA two-characters locale
options.metadata
object
options.redirectTo
string
default: https://my-app.comResponse
200 - application/json
mfa
object
mfa.ticket
string
session
object
session.accessToken
string
requiredsession.accessTokenExpiresIn
number
requiredsession.refreshToken
string
requiredRefresh token during authentication or when refreshing the JWT
session.user
object
session.user.activeMfaType
required
Multi-factor authentication type. A null value deactivates MFA
Available options:
totp
session.user.avatarUrl
string
requiredsession.user.createdAt
string
requiredsession.user.defaultRole
enum<string>
default: userrequiredAvailable options:
me
, user
session.user.displayName
string
requiredsession.user.email
string
requiredA valid email
session.user.emailVerified
boolean
default: falserequiredsession.user.id
string
Id of the user
session.user.isAnonymous
boolean
default: falserequiredsession.user.locale
string
default: enrequiredA two-characters locale
session.user.metadata
object
requiredsession.user.phoneNumber
string
requiredsession.user.phoneNumberVerified
boolean
default: falserequiredsession.user.roles
enum<string>[]
requiredAvailable options:
me
curl --request POST \
--url https://local.auth.nhost.run/v1/signup/email-password \
--header 'Content-Type: application/json' \
--data '{
"email": "john.smith@nhost.io",
"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"
}
}'
{
"mfa": {
"ticket": "<string>"
},
"session": {
"accessToken": "<string>",
"accessTokenExpiresIn": 123,
"refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"user": {
"activeMfaType": "totp",
"avatarUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"defaultRole": "user",
"displayName": "John Smith",
"email": "john.smith@nhost.io",
"emailVerified": true,
"id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
"isAnonymous": true,
"locale": "en",
"metadata": {
"firstName": "John",
"lastName": "Smith"
},
"phoneNumber": "<string>",
"phoneNumberVerified": true,
"roles": [
"me",
"user"
]
}
}
}