User Properties
User properties can be any information you want to store about a user. PropelAuth makes it easy to collect and store this information, whether it's manually through our admin dashboard, collected directly from the user, or set via our APIs.
Default User Properties
PropelAuth comes pre-configured with a set of default user properties. These are disabled by default, but can be enabled via the User Properties page of the dashboard. The default properties are:
| Property | Description |
|---|---|
| Name | Collect first and last name from your users. When you enable this property, first name and last name fields will be added to your Sign In flow and Account pages. These fields will be editable by the user. |
| Username | Enables your users to create a unique username. When you enable this property, a username field will be added to your Sign In flow and Account pages. This field will be editable by the user. |
| Profile Picture | Adds a Profile Picture section on the Account page where users can upload a picture. If your users sign in via a login method that sends over a profile picture (such a Google SSO), then that will be set at the time of signup. |
| Terms of Service | Upload a Terms of Service (or Privacy Policy, etc) URl and add a checkbox to your Sign Up flow that requires users accept the terms. |
| How did you hear about us? | Adds an enum field to your sign in flow where users can select how they heard about you. You can configure which dropdowns are selected, and you can also choose to have it show on the Account Page. |
| Metadata | An internal-only property that allows you to set arbitrary JSON associated with the user. |
Custom User Properties
PropelAuth customers on a paid plan can create their own user properties. For more information, see the Custom Properties guide.
FAQs
What happens if I turn on a required user property after I've already started onboarding users?
If you turn on a property that's required for all users, then your users will be asked to enter the property the next time they log in. If you turn on a required property for all users going forward, then the property will only be collected on sign up, though existing users will see the property and be able to edit it from their Account pages (if the property is set to appear there).
How do I edit a property on behalf of a user?
You can edit a property on behalf of a user via the Users page in the PropelAuth dashboard. You can also edit it via API (see API reference for details).