mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 12:27:45 +00:00
43 KiB
43 KiB
User
Fields
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
Optional<? extends String> | ➖ | N/A | |
object |
Optional<? extends com.clerk.backend_api.models.components.UserObject> | ➖ | String representing the object's type. Objects of the same type share the same value. |
|
externalId |
JsonNullable<? extends String> | ➖ | N/A | |
primaryEmailAddressId |
JsonNullable<? extends String> | ➖ | N/A | |
primaryPhoneNumberId |
JsonNullable<? extends String> | ➖ | N/A | |
primaryWeb3WalletId |
JsonNullable<? extends String> | ➖ | N/A | |
username |
JsonNullable<? extends String> | ➖ | N/A | |
firstName |
JsonNullable<? extends String> | ➖ | N/A | |
lastName |
JsonNullable<? extends String> | ➖ | N/A | |
profileImageUrl |
Optional<? extends String> | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | |
imageUrl |
Optional<? extends String> | ➖ | N/A | |
hasImage |
Optional<? extends Boolean> | ➖ | N/A | |
publicMetadata |
Optional<? extends com.clerk.backend_api.models.components.PublicMetadata> | ➖ | N/A | |
privateMetadata |
JsonNullable<? extends com.clerk.backend_api.models.components.PrivateMetadata> | ➖ | N/A | |
unsafeMetadata |
Optional<? extends com.clerk.backend_api.models.components.UnsafeMetadata> | ➖ | N/A | |
emailAddresses |
List<com.clerk.backend_api.models.components.EmailAddress> | ➖ | N/A | |
phoneNumbers |
List<com.clerk.backend_api.models.components.PhoneNumber> | ➖ | N/A | |
web3Wallets |
List<com.clerk.backend_api.models.components.Web3Wallet> | ➖ | N/A | |
passkeys |
List<com.clerk.backend_api.models.components.SchemasPasskey> | ➖ | N/A | |
passwordEnabled |
Optional<? extends Boolean> | ➖ | N/A | |
twoFactorEnabled |
Optional<? extends Boolean> | ➖ | N/A | |
totpEnabled |
Optional<? extends Boolean> | ➖ | N/A | |
backupCodeEnabled |
Optional<? extends Boolean> | ➖ | N/A | |
mfaEnabledAt |
JsonNullable<? extends 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<? extends 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<com.clerk.backend_api.models.components.ExternalAccounts> | ➖ | N/A | |
samlAccounts |
List<com.clerk.backend_api.models.components.SAMLAccount> | ➖ | N/A | |
lastSignInAt |
JsonNullable<? extends Long> | ➖ | Unix timestamp of last sign-in. |
|
banned |
Optional<? extends Boolean> | ➖ | Flag to denote whether user is banned or not. |
|
locked |
Optional<? extends Boolean> | ➖ | Flag to denote whether user is currently locked, i.e. restricted from signing in or not. |
|
lockoutExpiresInSeconds |
JsonNullable<? extends 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<? extends 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<? extends Long> | ➖ | Unix timestamp of last update. |
|
createdAt |
Optional<? extends Long> | ➖ | Unix timestamp of creation. |
|
deleteSelfEnabled |
Optional<? extends Boolean> | ➖ | If enabled, user can delete themselves via FAPI. |
|
createOrganizationEnabled |
Optional<? extends Boolean> | ➖ | If enabled, user can create organizations via FAPI. |
|
lastActiveAt |
JsonNullable<? extends Long> | ➖ | Unix timestamp of the latest session activity, with day precision. |
1700690400000 |