Skip to content

Latest commit

 

History

History
48 lines (44 loc) · 45.4 KB

File metadata and controls

48 lines (44 loc) · 45.4 KB

User

Success

Fields

Field Type Required Description Example
id Optional<String> N/A
object Optional<UserObject> String representing the object's type. Objects of the same type share the same value.
externalId JsonNullable<String> N/A
primaryEmailAddressId JsonNullable<String> N/A
primaryPhoneNumberId JsonNullable<String> N/A
primaryWeb3WalletId JsonNullable<String> N/A
username JsonNullable<String> N/A
firstName JsonNullable<String> N/A
lastName JsonNullable<String> N/A
profileImageUrl Optional<String> : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.
imageUrl Optional<String> N/A
hasImage Optional<Boolean> N/A
publicMetadata Optional<PublicMetadata> N/A
privateMetadata JsonNullable<PrivateMetadata> N/A
unsafeMetadata Optional<UnsafeMetadata> N/A
emailAddresses List<EmailAddress> N/A
phoneNumbers List<PhoneNumber> N/A
web3Wallets List<Web3Wallet> N/A
passkeys List<SchemasPasskey> N/A
passwordEnabled Optional<Boolean> N/A
twoFactorEnabled Optional<Boolean> N/A
totpEnabled Optional<Boolean> N/A
backupCodeEnabled Optional<Boolean> N/A
mfaEnabledAt JsonNullable<Long> 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 JsonNullable<Long> 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.
externalAccounts List<ExternalAccounts> N/A
samlAccounts List<SAMLAccount> N/A
lastSignInAt JsonNullable<Long> Unix timestamp of last sign-in.
banned Optional<Boolean> Flag to denote whether user is banned or not.
locked Optional<Boolean> Flag to denote whether user is currently locked, i.e. restricted from signing in or not.
lockoutExpiresInSeconds JsonNullable<Long> 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 JsonNullable<Long> 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.
updatedAt Optional<Long> Unix timestamp of last update.
createdAt Optional<Long> Unix timestamp of creation.
deleteSelfEnabled Optional<Boolean> If enabled, user can delete themselves via FAPI.
createOrganizationEnabled Optional<Boolean> If enabled, user can create organizations via FAPI.
createOrganizationsLimit JsonNullable<Long> The maximum number of organizations the user can create. 0 means unlimited.
lastActiveAt JsonNullable<Long> Unix timestamp of the latest session activity, with day precision.
1700690400000
legalAcceptedAt JsonNullable<Long> Unix timestamp of when the user accepted the legal requirements.
1700690400000