Skip to main content
POST
/
signin
/
anonymous
Sign In Anonymous
curl --request POST \
  --url https://local.auth.nhost.run/v1/signin/anonymous \
  --header 'Content-Type: application/json' \
  --data '{
  "displayName": "John Smith",
  "locale": "en",
  "metadata": {
    "firstName": "John",
    "lastName": "Smith"
  }
}'
{
  "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": false,
      "id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
      "isAnonymous": false,
      "locale": "en",
      "metadata": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "phoneNumber": "<string>",
      "phoneNumberVerified": false,
      "roles": [
        "me",
        "user"
      ]
    }
  }
}

Body

application/json
​
displayName
string
Example:

"John Smith"

​
locale
string
default:en

A two-characters locale

Required string length: 2
Example:

"en"

​
metadata
object
Example:
{ "firstName": "John", "lastName": "Smith" }

Response

User successfully authenticated

​
mfa
object
​
session
object
⌘I