Skip to content

Latest commit

 

History

History
53 lines (49 loc) · 56.6 KB

User.md

File metadata and controls

53 lines (49 loc) · 56.6 KB

User

Success

Fields

Field Type Required Description Example
Id string ✔️ N/A user_id_123
Object UserObject ✔️ String representing the object's type. Objects of the same type share the same value.
 user
ExternalId string ✔️ N/A external_user_id_123
PrimaryEmailAddressId string ✔️ N/A email_id_123
PrimaryPhoneNumberId string ✔️ N/A phone_id_123
PrimaryWeb3WalletId string ✔️ N/A wallet_id_123
Username string ✔️ N/A john_doe
FirstName string ✔️ N/A John
LastName string ✔️ N/A Doe
Locale string ➖ N/A
ProfileImageUrl string ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. https://example.com/profile.jpg
ImageUrl string ➖ N/A https://example.com/new-profile.jpg
HasImage bool ✔️ N/A true
PublicMetadata Dictionary<String, object> ✔️ N/A {
"role": "admin"
}
PrivateMetadata Dictionary<String, object> ➖ N/A {
"ssn": "123-45-6789"
}
UnsafeMetadata Dictionary<String, object> ➖ N/A {
"theme": "dark"
}
EmailAddresses List<EmailAddress> ✔️ N/A [
{
"id": "email_id_123",
"object": "email_address",
"email_address": "john.doe@example.com",
"verification": {
"status": "verified",
"strategy": "email_code"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
]
PhoneNumbers List<PhoneNumber> ✔️ N/A [
{
"id": "phone_id_123",
"object": "phone_number",
"phone_number": "+12345678901",
"verification": {
"status": "verified",
"strategy": "phone_code"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
]
Web3Wallets List<Web3Wallet> ✔️ N/A [
{
"id": "wallet_id_123",
"object": "web3_wallet",
"web3_wallet": "0x123456789abcdef",
"verification": {
"status": "verified",
"strategy": "web3_metamask_signature"
},
"created_at": 1609459200,
"updated_at": 1609459200
}
]
Passkeys List<Passkey> ✔️ N/A [
{
"id": "passkey_id_123",
"object": "passkey",
"name": "My Passkey",
"last_used_at": 1615852800,
"verification": {
"status": "verified",
"strategy": "passkey"
}
}
]
PasswordEnabled bool ✔️ N/A true
TwoFactorEnabled bool ✔️ N/A true
TotpEnabled bool ✔️ N/A true
BackupCodeEnabled bool ✔️ N/A true
MfaEnabledAt 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.
 1615852800
MfaDisabledAt 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 long ➖ Unix timestamp of when the user's password was last updated.
ExternalAccounts List<ExternalAccountWithVerification> ✔️ N/A [
{
"id": "ext_account_id_123",
"provider": "Facebook",
"user_id": "user_id_at_provider"
}
]
SamlAccounts List<SAMLAccount> ✔️ N/A [
{
"id": "saml_account_id_123",
"object": "saml_account",
"provider": "SAML Provider",
"active": true,
"email_address": "user@example.com",
"public_metadata": {
"department": "IT"
},
"verification": {
"status": "verified",
"strategy": "saml"
}
}
]
EnterpriseAccounts List<EnterpriseAccount> ✔️ N/A
OrganizationMemberships List<OrganizationMembership> ➖ N/A
LastSignInAt long ✔️ Unix timestamp of last sign-in.
 1622852400
Banned bool ✔️ Flag to denote whether user is banned or not.
 false
Locked bool ✔️ Flag to denote whether user is currently locked, i.e. restricted from signing in or not.
 false
LockoutExpiresInSeconds 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 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.
 5
UpdatedAt long ✔️ Unix timestamp of last update.
 1622852400
CreatedAt long ✔️ Unix timestamp of creation.
 1609459200
DeleteSelfEnabled bool ✔️ If enabled, user can delete themselves via FAPI.
 true
CreateOrganizationEnabled bool ✔️ If enabled, user can create organizations via FAPI.
 true
CreateOrganizationsLimit long ➖ The maximum number of organizations the user can create. 0 means unlimited.
LastActiveAt long ✔️ Unix timestamp of the latest session activity, with day precision.
 1700690400000
LegalAcceptedAt long ✔️ Unix timestamp of when the user accepted the legal requirements.
 1700690400000
BypassClientTrust bool ➖ When set to true, the user will bypass client trust checks during sign-in.