GET
/
user
curl --request GET \
  --url https://local.auth.local.nhost.run/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "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"
  ]
}

Authorizations

Authorization
string
header
required

JSON Web Token to authorize requests.

Response

200
application/json
User information
activeMfaType
required

Multi-factor authentication type. A null value deactivates MFA

Available options:
totp
Example:

"totp"

avatarUrl
string
required
createdAt
string
required
defaultRole
enum<string>
default:user
required
Available options:
me,
user
Example:

"user"

displayName
string
required
Example:

"John Smith"

email
string
required

A valid email

Example:

"john.smith@nhost.io"

emailVerified
boolean
default:false
required
isAnonymous
boolean
default:false
required
locale
string
default:en
required

A two-characters locale

Required string length: 2
Example:

"en"

metadata
object
required
Example:
{ "firstName": "John", "lastName": "Smith" }
phoneNumber
string
required
phoneNumberVerified
boolean
default:false
required
roles
enum<string>[]
required
Available options:
me
Example:
["me", "user"]
id
string

Id of the user

Example:

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