Skip to main content

UserSchema

_active_rolenullable
_tenantnullable

Tenant that I am a member of

_two_factor_required_bydatenullable
activeboolean
active_role_idintegernullable

The role_id of the role the user is currently using

association_contactsundefined[]
can_impersonate_billing_contactboolean
can_impersonate_brokerboolean
claim_requestsundefined[]
confirmed_atdate-timenullable
createddatedate-timenullable
current_login_atdate-time
current_login_ipstring
date_of_birthdatenullable
default_dashboardstring
emailstringnullable
employer_usersundefined[]
enabled_policy_holdersundefined[]
expiredboolean
extendednullable

Extra fields for the User table

feature_flag_api_userboolean
feature_flag_sshboolean
feature_flag_two_factorboolean
first_namestringnullable
fs_token_uniquifieruuidnullable
fs_uniquifieruuid
full_namestringnullable

DEPRECIATED use first_name and last_name

full_name_derivedstring
has_taken_tourboolean
hashed_api_keystringnullable
idinteger
impersonate_idstring
is_api_userboolean
is_beacon_userboolean
is_ssobooleannullable
is_two_factor_setupboolean
javascript_sdk_tokensundefined[]
last_known_breach_checkdate-timenullable
last_login_atdate-time
last_login_ipstring
last_namestringnullable
last_successful_otpstringnullable
last_successful_otp_atdate-timenullable
login_attemptsundefined[]
login_countinteger
modifieddatedate-timenullable
otp_secretstringnullable

Possible values: <= 16 characters

password_complexity_user_dictionarystring[]
policy_holder_successful_emailsundefined[]
prefer_new_uxboolean
sales_entity_usersundefined[]
second_last_successful_otpstringnullable
ssnstringnullable
tenant_idintegernullable
time_zonestring
titlestringnullable
two_factor_preference
two_factor_requiredboolean
user_flask_login_auditsundefined[]
user_idinteger
user_membersundefined[]
user_teamundefined[]
uuiduuid
UserSchema
{
  "_two_factor_required_by": "2024-07-29",
  "active": true,
  "active_role_id": 0,
  "association_contacts": [
    null
  ],
  "can_impersonate_billing_contact": true,
  "can_impersonate_broker": true,
  "claim_requests": [
    null
  ],
  "confirmed_at": "2024-07-29T15:51:28.071Z",
  "createddate": "2024-07-29T15:51:28.071Z",
  "current_login_at": "2024-07-29T15:51:28.071Z",
  "current_login_ip": "string",
  "date_of_birth": "2024-07-29",
  "default_dashboard": "string",
  "email": "string",
  "employer_users": [
    null
  ],
  "enabled_policy_holders": [
    null
  ],
  "expired": true,
  "feature_flag_api_user": true,
  "feature_flag_ssh": true,
  "feature_flag_two_factor": true,
  "first_name": "string",
  "fs_token_uniquifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "fs_uniquifier": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "full_name": "string",
  "full_name_derived": "string",
  "has_taken_tour": true,
  "hashed_api_key": "string",
  "id": 0,
  "impersonate_id": "string",
  "is_api_user": true,
  "is_beacon_user": true,
  "is_sso": true,
  "is_two_factor_setup": true,
  "javascript_sdk_tokens": [
    null
  ],
  "last_known_breach_check": "2024-07-29T15:51:28.071Z",
  "last_login_at": "2024-07-29T15:51:28.071Z",
  "last_login_ip": "string",
  "last_name": "string",
  "last_successful_otp": "string",
  "last_successful_otp_at": "2024-07-29T15:51:28.071Z",
  "login_attempts": [
    null
  ],
  "login_count": 0,
  "modifieddate": "2024-07-29T15:51:28.071Z",
  "otp_secret": "string",
  "password_complexity_user_dictionary": [
    "string"
  ],
  "policy_holder_successful_emails": [
    null
  ],
  "prefer_new_ux": true,
  "sales_entity_users": [
    null
  ],
  "second_last_successful_otp": "string",
  "ssn": "string",
  "tenant_id": 0,
  "time_zone": "string",
  "title": "string",
  "two_factor_preference": {},
  "two_factor_required": true,
  "user_flask_login_audits": [
    null
  ],
  "user_id": 0,
  "user_members": [
    null
  ],
  "user_team": [
    null
  ],
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}