Configuring User Properties


We're almost there! One of the last steps in getting our app ready is configuring our user properties. These are fields that you can use to store information about your users. They can be set manually through our admin dashboard, collected directly from the user, or set via our APIs. Head over to the User Properties page in your dashboard to get started.

Enabling Default User Properties

PropelAuth offers multiple user properties out of the box, such as name, profile picture, and username. You can enable or disable any of these at any time, as well as customize them to your liking.

For example, you can enable the referral_source property which will be collected at signup. From there, you can customize the label, the options the user has to choose from, if it's required, and if the user can later edit the value.

Referral Source Property

Don't see the right field for you? You can also create your own custom user properties. Click here for more information.

Including Properties in the Access Token

Many of our user properties allow you to choose whether the property is contained within the access token. Here are some things to consider when making this choice:

  • Is the field something you want your users to see? Even if you're not displaying the information on your frontend, a savvy user could track down and decode the access token themselves. If that's the case, not including the field in the access token would be a good choice.

  • Do you imagine using the field a lot? If so, you can cut down on backend requests by including the field in your access token.

Setting User Properties

There are several ways to set a user property:

  • Have your users set them themselves
  • Set them in the PropelAuth dashboard
  • Set them via the API

Let's assume that we want to update a user's first name, last name, a custom property called "favoriteSport", and the user's metadata. If we want to do this programmatically, we can do so using the Update User API.

Missing Frameworks
The next section is personalized to your frameworks (but will default to React & FastAPI). Please select the frameworks you use and we'll only show you relevant content.
userId = # get userId somehow
    "favoriteSport": "basketball",
    "metadata": {
      "someData": "someValue"

Next Steps

You're almost done! Next, we'll be deploying your app to production.