User.md

User

Success

Fields

Field	Type	Required	Description	Example
id	?string	➖	N/A
object	?Components\UserObject	➖	String representing the object's type. Objects of the same type share the same value.
profileImageUrl	?string	➖	: warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
imageUrl	?string	➖	N/A
hasImage	?bool	➖	N/A
publicMetadata	array<string, mixed>	➖	N/A
unsafeMetadata	array<string, mixed>	➖	N/A
emailAddresses	array<Components\EmailAddress>	➖	N/A
phoneNumbers	array<Components\PhoneNumber>	➖	N/A
web3Wallets	array<Components\Web3Wallet>	➖	N/A
passkeys	array<Components\SchemasPasskey>	➖	N/A
passwordEnabled	?bool	➖	N/A
twoFactorEnabled	?bool	➖	N/A
totpEnabled	?bool	➖	N/A
backupCodeEnabled	?bool	➖	N/A
externalAccounts	array<Components\ExternalAccounts>	➖	N/A
samlAccounts	array<Components\SAMLAccount>	➖	N/A
banned	?bool	➖	Flag to denote whether user is banned or not.
locked	?bool	➖	Flag to denote whether user is currently locked, i.e. restricted from signing in or not.
updatedAt	?int	➖	Unix timestamp of last update.
createdAt	?int	➖	Unix timestamp of creation.
deleteSelfEnabled	?bool	➖	If enabled, user can delete themselves via FAPI.
createOrganizationEnabled	?bool	➖	If enabled, user can create organizations via FAPI.
externalId	?string	➖	N/A
primaryEmailAddressId	?string	➖	N/A
primaryPhoneNumberId	?string	➖	N/A
primaryWeb3WalletId	?string	➖	N/A
username	?string	➖	N/A
firstName	?string	➖	N/A
lastName	?string	➖	N/A
privateMetadata	array<string, mixed>	➖	N/A
mfaEnabledAt	?int	➖	Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.
mfaDisabledAt	?int	➖	Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.
lastSignInAt	?int	➖	Unix timestamp of last sign-in.
lockoutExpiresInSeconds	?int	➖	The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.
verificationAttemptsRemaining	?int	➖	The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.
createOrganizationsLimit	?int	➖	The maximum number of organizations the user can create. 0 means unlimited.
lastActiveAt	?int	➖	Unix timestamp of the latest session activity, with day precision.	1700690400000
legalAcceptedAt	?int	➖	Unix timestamp of when the user accepted the legal requirements.	1700690400000