Users - Data Structures

JSON schema in Github

The JSON for the base user record can be found in Github here: https://github.com/folio-org/mod-users/blob/master/ramls/userdata.json

Required fields

Note that while the JSON schema doesn't list any fields as required, the UI enforces requiring the following fields when a user account is created (correct as of Juniper):

• Last name
• Patron group
• Status (defaults to active)
• Email address
• Preferred contact method (defaults to email)

In addition, if you use mod-user-import to create user records, mod-user import requires

• username
• external system id

Tip: Not everything you see in the Users app is part of the User record

One thing that's important to understand is that, with the appropriate permissions, you will see much more on a user record in the Users app UI than is actually part of the underlying base record. For example, in the FOLIO UI, you could see all of these accordions on a user record:

But, the only part of this screen that's in the user record is the User information, Extended information, Contact information, and Custom fields. All of the other accordions are data that is stored outside of the user record but linked back to the user through the UUID. This has implications for reporting, depending on your chosen reporting tool.