Skip to content
Nhost Documentation
Search
Ctrl
K
Cancel
Twitter
GitHub
LinkedIn
Support
Dashboard
Reference
Sections
Welcome
Getting Started
Platform
Reference
Blog
Products
Overview
Database
GraphQL
Auth
Storage
Run
Functions
AI
Support
Dashboard
Welcome
Getting Started
Products
Overview
Database
GraphQL
Auth
Storage
Run
Functions
AI
Platform
Reference
Blog
Getting Started
Products
Database
GraphQL
Auth
Storage
Run
Functions
AI
Platform
Reference
Reference
Backend Services
Auth API
Overview
/signin/anonymous
POST
/signin/email-password
POST
/signin/idtoken
POST
/signin/mfa/totp
POST
/signin/otp/email
POST
/signin/otp/email/verify
POST
/signin/passwordless/email
POST
/signin/passwordless/sms
POST
/signin/passwordless/sms/otp
POST
/signin/pat
POST
/signin/provider/{provider}
GET
/signin/provider/{provider}/callback
GET
/signin/provider/{provider}/callback
POST
/signin/provider/{provider}/callback/tokens
GET
/signin/webauthn
POST
/signin/webauthn/verify
POST
/signup/email-password
POST
/signup/webauthn
POST
/signup/webauthn/verify
POST
/token/provider/{provider}
POST
/user/deanonymize
POST
/elevate/webauthn
POST
/elevate/webauthn/verify
POST
/link/idtoken
POST
/pat
POST
/user/mfa
POST
/user/webauthn/add
POST
/user/webauthn/verify
POST
/signout
POST
/token
POST
/token/verify
POST
/mfa/totp/generate
GET
/user
GET
/user/email/change
POST
/user/email/send-verification-email
POST
/user/password
POST
/user/password/reset
POST
/.well-known/jwks.json
GET
/healthz
GET
/healthz
HEAD
/version
GET
/verify
GET
Storage API
Overview
/openapi.yaml
GET
/files/{id}/presignedurl/contents
GET
/files
POST
/files/{id}
GET
/files/{id}
PUT
/files/{id}
DELETE
/files/{id}
HEAD
/ops/delete-broken-metadata
POST
/ops/delete-orphans
POST
/ops/list-broken-metadata
POST
/ops/list-not-uploaded
POST
/ops/list-orphans
POST
/files/{id}/presignedurl
GET
/version
GET
AI GraphQL
Overview
Query
assistant
assistants
session
sessionMessages
sessions
Mutation
insertAssistant
updateAssistant
deleteAssistant
startSession
deleteSession
sendMessage
startDevSession
sendDevMessage
Client Libraries
JavaScript
nhost-js
Main
Auth
Functions
Graphql
Storage
Session
Fetch
CLI
Commands
Deprecated Libraries
javascript
auth
addSecurityKey()
AuthCookieClient
changeEmail()
changePassword()
connectProvider()
createPAT()
deanonymize()
elevateEmailSecurityKey()
getAccessToken()
getAuthenticationStatus()
getDecodedAccessToken()
getHasuraClaim()
getHasuraClaims()
getSession()
getUser()
HasuraAuthClient
isAuthenticated()
isAuthenticatedAsync()
linkIdToken()
onAuthStateChanged()
onTokenChanged()
refreshSession()
resetPassword()
sendVerificationEmail()
signIn()
signInEmailOTP()
signInIdToken()
signInPAT()
signInSecurityKey()
signOut()
signUp()
start()
subscribe()
types
ActivateMfaHandlerResult
ActivateMfaState
AddSecurityKeyHandlerResult
AddSecurityKeyState
AuthActionErrorState
AuthActionLoadingState
AuthActionSuccessState
AuthChangeEvent
AuthChangedFunction
AuthContext
AuthErrorPayload
AuthEvents
AuthInterpreter
AuthMachine
AuthMachineOptions
AuthOptions
ChangeEmailContext
ChangeEmailEvents
ChangeEmailHandlerResult
ChangeEmailMachine
ChangeEmailOptions
ChangeEmailParams
ChangeEmailResponse
ChangeEmailServices
ChangeEmailState
ChangePasswordContext
ChangePasswordEvents
ChangePasswordHandlerResult
ChangePasswordMachine
ChangePasswordParams
ChangePasswordResponse
ChangePasswordServices
ChangePasswordState
ClientStorage
ClientStorageType
CommonProviderOptions
CommonSignUpParams
DeanonymizeOptions
DeanonymizeParams
DeanonymizeResponse
ElevateWithSecurityKeyHandlerResult
EmailOTPOptions
EnableMfaContext
EnableMfaEvents
EnableMfadMachine
GenerateQrCodeHandlerResult
GenerateQrCodeState
JWTClaims
JWTHasuraClaims
LinkIdTokenHandlerParams
LinkIdTokenHandlerResult
LinkIdTokenParams
Mfa
NeedsEmailVerificationState
NhostAuthConstructorParams
NhostClientOptions
NhostSession
NhostSessionResponse
NullableErrorResponse
OnTokenChangedFunction
PasswordlessEmailResponse
PasswordlessOptions
PasswordlessSmsOtpResponse
PasswordlessSmsResponse
PersonalAccessTokenCreationResponse
Provider
ProviderOptions
RedirectOption
RefreshSessionResponse
RequestOptions
ResetPasswordContext
ResetPasswordEvents
ResetPasswordHandlerResult
ResetPasswordMachine
ResetPasswordOptions
ResetPasswordParams
ResetPasswordResponse
ResetPasswordServices
ResetPasswordState
SecurityKey
SendVerificationEmailContext
SendVerificationEmailEvents
SendVerificationEmailHandlerResult
SendVerificationEmailMachine
SendVerificationEmailOptions
SendVerificationEmailParams
SendVerificationEmailResponse
SendVerificationEmailServices
SendVerificationEmailState
SessionActionHandlerResult
SignInAnonymousHandlerResult
SignInAnonymousResponse
SignInAnonymousState
SignInEmailPasswordHandlerResult
SignInEmailPasswordOtpParams
SignInEmailPasswordParams
SignInEmailPasswordState
SignInEmailPasswordlessHandlerResult
SignInEmailPasswordlessState
SignInIdTokenHandlerParams
SignInIdTokenHandlerResult
SignInIdTokenParams
SignInIdTokenState
SignInMfaTotpHandlerResult
SignInMfaTotpResponse
SignInMfaTotpState
SignInParams
SignInPasswordlessEmailParams
SignInPasswordlessSecurityKeyParams
SignInPasswordlessSmsOtpParams
SignInPasswordlessSmsParams
SignInPATHandlerResult
SignInPATResponse
SignInPATState
SignInResponse
SignInSecurityKeyPasswordlessHandlerResult
SignInSecurityKeyPasswordlessState
SignInSmsPasswordlessHandlerResult
SignInSmsPasswordlessOtpHandlerResult
SignInSmsPasswordlessOtpState
SignInSmsPasswordlessState
SignInWithProviderParams
SignOutResponse
SignOutlessHandlerResult
SignOutlessState
SignUpEmailPasswordHandlerResult
SignUpEmailPasswordParams
SignUpEmailPasswordState
SignUpOptions
SignUpParams
SignUpResponse
SignUpSecurityKeyHandlerResult
SignUpSecurityKeyOptions
SignUpSecurityKeyParams
SignUpSecurityKeyState
StateErrorTypes
StorageGetter
StorageSetter
User
ValidationAuthErrorPayload
WorkOsOptions
verifyEmailOTP()
functions
call()
createFunctionsClient()
NhostFunctionsClient
setAccessToken()
graphql
getHeaders()
getUrl()
GraphQL
request()
setAccessToken()
setHeaders()
unsetHeaders()
nhost-js
linkIdToken()
NhostClient
setRole()
signInEmailOTP()
signInIdToken()
signInSecurityKey()
types
AuthOptions
ClientStorage
ClientStorageType
LinkIdTokenHandlerParams
LinkIdTokenHandlerResult
LinkIdTokenParams
NhostClientConstructorParams
SignInIdTokenHandlerParams
SignInIdTokenHandlerResult
SignInIdTokenParams
SignInIdTokenState
unsetRole()
storage
delete()
download()
getHeaders()
getPresignedUrl()
getPublicUrl()
Storage
setAccessToken()
setAdminSecret()
setHeaders()
types
AnyFileList
ApiDeleteParams
ApiDeleteResponse
ApiGetPresignedUrlParams
ApiGetPresignedUrlResponse
FileItemRef
FileResponse
FileUploadConfig
FileUploadContext
FileUploadEventPayload
FileUploadEvents
FileUploadMachine
FileUploadState
MultipleFilesHandlerResult
MultipleFilesUploadContext
MultipleFilesUploadEvents
MultipleFilesUploadMachine
MultipleFilesUploadState
MultipleUploadProgressState
NhostStorageConstructorParams
StorageActionErrorState
StorageDeleteParams
StorageDeleteResponse
StorageDownloadFileParams
StorageDownloadFileResponse
StorageErrorPayload
StorageGetPresignedUrlParams
StorageGetPresignedUrlResponse
StorageGetUrlParams
StorageHeadersParam
StorageImageTransformationParams
StorageUploadFileParams
StorageUploadFileResponse
StorageUploadFormDataParams
StorageUploadFormDataResponse
StorageUploadParams
StorageUploadResponse
UploadFileHandlerResult
UploadHeaders
UploadMultipleFilesActionParams
UploadProgressState
unsetHeaders()
upload()
nextjs
createServerSideClient()
getNhostSession()
NhostClient
<SignedIn />
<SignedOut />
types
AddSecuritKeyHookResult
AuthMachine
ChangeEmailHookResult
ChangePasswordHookResult
CreateServerSideClientParams
ErrorPayload
FileItemRef
FileUploadHookResult
LinkIdTokenHookResult
MultipleFilesHookResult
NhostAuthConstructorParams
NhostNextClientConstructorParams
NhostProviderProps
NhostReactClientConstructorParams
NhostSession
ResetPasswordHookResult
SendVerificationEmailHookResult
SignInEmailPasswordHookResult
SignInEmailPasswordlessHookResult
SignInIdTokenHookResult
SignInPATHookResult
SignInSecurityKeyPasswordlessHookResult
SignInSmsPasswordlessHandler
SignInSmsPasswordlessHookResult
SignInSmsPasswordlessOtpHandler
SignUpEmailPasswordHookResult
SignUpSecurityKeyHookResult
Subdomain
User
useAccessToken()
useAddSecurityKey()
useAuthenticated()
useAuthenticationStatus()
useChangeEmail()
useChangePassword()
useConfigMfa()
useDecodedAccessToken()
useElevateSecurityKeyEmail()
useFileUpload()
useFileUploadItem()
useHasuraClaim()
useHasuraClaims()
useLinkIdToken()
useMultipleFilesUpload()
useNhostClient()
useProviderLink()
useResetPassword()
useSendVerificationEmail()
useSignInAnonymous()
useSignInEmailOTP()
useSignInEmailPassword()
useSignInEmailPasswordless()
useSignInEmailSecurityKey()
useSignInIdToken()
useSignInPAT()
useSignInSecurityKey()
useSignInSmsPasswordless()
useSignOut()
useSignUpEmailPassword()
useSignUpEmailSecurityKeyEmail()
useUserAvatarUrl()
useUserData()
useUserDefaultRole()
useUserDisplayName()
useUserEmail()
useUserId()
useUserIsAnonymous()
useUserLocale()
useUserRoles()
react
NhostClient
<SignedIn />
<SignedOut />
types
AddSecuritKeyHookResult
AuthMachine
ChangeEmailHookResult
ChangePasswordHookResult
ErrorPayload
FileItemRef
FileUploadHookResult
LinkIdTokenHookResult
MultipleFilesHookResult
NhostAuthConstructorParams
NhostProviderProps
NhostReactClientConstructorParams
NhostSession
ResetPasswordHookResult
SendVerificationEmailHookResult
SignInEmailPasswordHookResult
SignInEmailPasswordlessHookResult
SignInIdTokenHookResult
SignInPATHookResult
SignInSecurityKeyPasswordlessHookResult
SignInSmsPasswordlessHandler
SignInSmsPasswordlessHookResult
SignInSmsPasswordlessOtpHandler
SignUpEmailPasswordHookResult
SignUpSecurityKeyHookResult
Subdomain
User
useAccessToken()
useAddSecurityKey()
useAuthenticated()
useAuthenticationStatus()
useChangeEmail()
useChangePassword()
useConfigMfa()
useDecodedAccessToken()
useElevateSecurityKeyEmail()
useFileUpload()
useFileUploadItem()
useHasuraClaim()
useHasuraClaims()
useLinkIdToken()
useMultipleFilesUpload()
useNhostClient()
useProviderLink()
useResetPassword()
useSendVerificationEmail()
useSignInAnonymous()
useSignInEmailOTP()
useSignInEmailPassword()
useSignInEmailPasswordless()
useSignInEmailSecurityKey()
useSignInIdToken()
useSignInPAT()
useSignInSecurityKey()
useSignInSmsPasswordless()
useSignOut()
useSignUpEmailPassword()
useSignUpEmailSecurityKeyEmail()
useUserAvatarUrl()
useUserData()
useUserDefaultRole()
useUserDisplayName()
useUserEmail()
useUserId()
useUserIsAnonymous()
useUserLocale()
useUserRoles()
react-native
React Native Support
vue
NhostClient
types
AddSecuritKeyComposableResult
ChangeEmailComposableResult
ChangePasswordComposableResult
ConfigMfaComposableState
ErrorPayload
FileItemRef
FileUploadComposableResult
LinkIdTokenResult
MultipleFilesUploadComposableResult
NhostSession
NhostVueClientConstructorParams
SignInSecurityKeyPasswordlessHookResult
SignInSmsPasswordlessComposableResult
SignInSmsPasswordlessHandler
SignInSmsPasswordlessOtpHandler
SignUpSecurityKeyHookResult
Subdomain
User
useAccessToken()
useAddSecurityKey()
useAuthenticated()
useAuthenticationStatus()
useChangeEmail()
useChangePassword()
useDecodedAccessToken()
useElevateSecurityKeyEmail()
useFileUpload()
useFileUploadItem()
useHasuraClaim()
useHasuraClaims()
useLinkIdToken()
useMultipleFilesUpload()
useNhostClient()
useProviderLink()
useResetPassword()
useSendVerificationEmail()
useSignInAnonymous()
useSignInEmailOTP()
useSignInEmailPassword()
useSignInEmailPasswordless()
useSignInEmailSecurityKey()
useSignInIdToken()
useSignInPAT()
useSignInSecurityKey()
useSignInSmsPasswordless()
useSignOut()
useSignUpEmailPassword()
useSignUpEmailSecurityKey()
useUserAvatarUrl()
useUserData()
useUserDefaultRole()
useUserDisplayName()
useUserEmail()
useUserId()
useUserIsAnonymous()
useUserLocale()
useUserRoles()
Twitter
GitHub
LinkedIn
NhostClientOptions
NhostClientOptions
Section titled “NhostClientOptions”
type
NhostClientOptions
=
AuthMachineOptions
&
__type
