Success
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
id |
String | ✔️ | N/A | |
object |
UserObject | ✔️ | String representing the object's type. Objects of the same type share the same value. |
|
externalId |
Optional<String> | ✔️ | N/A | |
primaryEmailAddressId |
Optional<String> | ✔️ | N/A | |
primaryPhoneNumberId |
Optional<String> | ✔️ | N/A | |
primaryWeb3WalletId |
Optional<String> | ✔️ | N/A | |
username |
Optional<String> | ✔️ | N/A | |
firstName |
Optional<String> | ✔️ | N/A | |
lastName |
Optional<String> | ✔️ | N/A | |
locale |
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 |
boolean | ✔️ | N/A | |
publicMetadata |
Map<String, Object> | ✔️ | N/A | |
privateMetadata |
Map<String, Object> | ➖ | N/A | |
unsafeMetadata |
Map<String, Object> | ➖ | N/A | |
emailAddresses |
List<EmailAddress> | ✔️ | N/A | |
phoneNumbers |
List<PhoneNumber> | ✔️ | N/A | |
web3Wallets |
List<Web3Wallet> | ✔️ | N/A | |
passkeys |
List<Passkey> | ✔️ | N/A | |
passwordEnabled |
boolean | ✔️ | N/A | |
twoFactorEnabled |
boolean | ✔️ | N/A | |
totpEnabled |
boolean | ✔️ | N/A | |
backupCodeEnabled |
boolean | ✔️ | N/A | |
mfaEnabledAt |
Optional<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 |
Optional<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. |
|
passwordLastUpdatedAt |
JsonNullable<Long> | ➖ | Unix timestamp of when the user's password was last updated. |
|
externalAccounts |
List<ExternalAccountWithVerification> | ✔️ | N/A | |
samlAccounts |
List<SAMLAccount> | ✔️ | N/A | |
enterpriseAccounts |
List<EnterpriseAccount> | ✔️ | N/A | |
organizationMemberships |
List<OrganizationMembership> | ➖ | N/A | |
lastSignInAt |
Optional<Long> | ✔️ | Unix timestamp of last sign-in. |
|
banned |
boolean | ✔️ | Flag to denote whether user is banned or not. |
|
locked |
boolean | ✔️ | Flag to denote whether user is currently locked, i.e. restricted from signing in or not. |
|
deprovisioned |
Optional<Boolean> | ➖ | Flag to denote whether user has been deprovisioned and is restricted from signing in. |
|
lockoutExpiresInSeconds |
Optional<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 |
Optional<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 |
long | ✔️ | Unix timestamp of last update. |
|
createdAt |
long | ✔️ | Unix timestamp of creation. |
|
deleteSelfEnabled |
boolean | ✔️ | If enabled, user can delete themselves via FAPI. |
|
createOrganizationEnabled |
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 |
Optional<Long> | ✔️ | Unix timestamp of the latest session activity, with day precision. |
1700690400000 |
legalAcceptedAt |
Optional<Long> | ✔️ | Unix timestamp of when the user accepted the legal requirements. |
1700690400000 |
bypassClientTrust |
Optional<Boolean> | ➖ | When set to true, the user will bypass client trust checks during sign-in. |
|
scim |
JsonNullable<Scim> | ➖ | N/A |