Nest Authbeta

GET /auth/user

Get Logged In User

Get Logged In User

GET/auth/user

Responses

200

UserResponseDto

FieldTypeRequiredDescription
idstringrequiredUser unique identifier
Example: 123e4567-e89b-12d3-a456-426614174000
emailstringoptionalUser email address
Example: user@example.com
phonestringoptionalUser phone number
Example: +1234567890
emailVerifiedAtstring<date-time>requiredEmail verification status
Example: true
phoneVerifiedAtstring<date-time>requiredPhone verification status
Example: true
isMfaEnabledbooleanoptionalWhether MFA is enabled for this user
Example: false
rolesstring[]optionalUser roles (role names)
Example: ["admin","user"]
permissionsstring[]optionalUser permissions (flattened from roles)
Example: ["read:users","write:users"]
metadataobjectoptionalAdditional user metadata
Example: {"firstName":"John","lastName":"Doe"}
tenantIdstringoptionalTenant ID for multi-tenant applications
Example: tenant-123

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "user@example.com",
  "phone": "+1234567890",
  "emailVerifiedAt": true,
  "phoneVerifiedAt": true,
  "isMfaEnabled": false,
  "roles": [
    "admin",
    "user"
  ],
  "permissions": [
    "read:users",
    "write:users"
  ],
  "metadata": {
    "firstName": "John",
    "lastName": "Doe"
  },
  "tenantId": "tenant-123"
}

Try it

curl -X GET 'https://api.example.com/auth/user' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

On this page