Skip to content

Deanonymize an anonymous user

POST
/user/deanonymize

Convert an anonymous user to a regular user by adding email and optionally password credentials. A confirmation email will be sent if the server is configured to do so.

Authentication method and credentials to convert anonymous user to regular user

object
signInMethod
required

Which sign-in method to use

string
Allowed values: email-password passwordless
email
required

A valid email

string format: email
Example
john.smith@nhost.io
password

A password of minimum 3 characters

string
>= 3 characters <= 50 characters
Example
Str0ngPassw#ord-94|%
connection

Deprecated, will be ignored

string
options
object
allowedRoles
Array<string>
Example
[
"me",
"user"
]
defaultRole
string
Example
user
displayName
string
<= 32 characters /^[\p{L}\p{N}\p{S} ,.'-]+$/
Example
John Smith
locale

A two or three characters locale

string
>= 2 characters <= 3 characters
Example
en
metadata
object
key
additional properties
any
Example
{
"firstName": "John",
"lastName": "Smith"
}
redirectTo
string format: uri
Example
https://my-app.com/catch-redirection

User deanonymized successfully

string
Allowed values: OK

An error occurred while processing the request

Standardized error response

object
status
required

HTTP status error code

integer
Example
400
message
required

Human-friendly error message

string
Example
Invalid email format
error
required

Error code identifying the specific application error

string
Allowed values: default-role-must-be-in-allowed-roles disabled-endpoint disabled-user email-already-in-use email-already-verified forbidden-anonymous internal-server-error invalid-email-password invalid-request locale-not-allowed password-too-short password-in-hibp-database redirectTo-not-allowed role-not-allowed signup-disabled unverified-user user-not-anonymous invalid-pat invalid-refresh-token invalid-ticket disabled-mfa-totp no-totp-secret invalid-totp mfa-type-not-found totp-already-active invalid-state oauth-token-echange-failed oauth-profile-fetch-failed oauth-provider-error invalid-otp cannot-send-sms provider-account-already-linked