FM BetterForms
BF Editorfmbetterforms.com
1.0 dont use
1.0 dont use
  • Introduction
  • Features Summary
  • Getting Started
    • System Overview
    • Integration
      • 1. Configure FileMaker Server
      • 2. Add your Server to BetterForms
      • 3. Introduction to Hooks
      • 4. Create your first Site
      • 5. Create your first Page
      • 6. Configure your FileMaker File(s)
      • 7. Run your first Hook
      • Next Steps
    • Common Customizations
      • Introduction to Actions
      • Introduction to Buttons
      • Page Navigation
      • Displaying Data in a Table
    • Support
      • Hacking a Webpage
      • Learning JSON
  • Reference
    • Site Settings
      • Navigation
      • Slots / Code Injection
      • App Model
      • Site-wide Named Actions
    • Page Settings
      • Data Model
      • Card / Window Modals
      • Validation
        • Custom Validators
      • Misc Page Settings
    • Page Elements
      • Common
        • Button
        • Data Table
        • HTML
      • Grouping Elements
        • Tabs
        • panel
        • accordion
        • listrows
      • Uploading Files
        • dropzone
        • dropzone to S3
        • uploadCare
      • Misc Elements
        • Plain Text / Code Editor
        • signature
        • fullCalendar
        • rangeSlider
      • Payment Gateways
        • Authorize.net
        • PayPal
        • Stripe
      • Adding Custom Page Elements
    • Actions Processor
      • Named Actions
      • Actions
        • runUtilityHook
        • path
        • debounce
        • throttle
        • showAlert
        • showModal / hideModal
        • function
        • clipboard
        • cookie
        • setFocus
        • wait
        • emit
        • validate
        • channelJoinAnon
        • channelLeaveAnon
        • messageSend
        • messageSendAnonChannel
      • Authentication Actions
    • Script Hooks
      • Globals Variables
        • $$BF_Model
        • $$BF_App
        • $$BF_State
      • Keeping Keys Private
      • Reducing Payload Size
      • API Callback Endpoint
      • Common Hooks
      • Scoped Hooks
    • Users & Authentication
      • Managing User Accounts
      • Custom Login Pages
    • Advanced Configuration
      • Custom Domains
    • BF Utility Functions
    • BF Error Codes
    • Messaging
      • Adding users to channels
      • Removing users from channels
      • Sending messages
      • Get connected users
      • Get active channels
  • Usage Tips
    • Troubleshooting
      • Debugging
      • Frozen Actions Queue
    • JavaScript Tips
      • Calling Named Actions from HTML Vue Events
      • Calculations
    • System Overview
    • Forms Processor
      • Form Types
      • HTML & VueJS
      • Styling and Design
      • JS Caclulations and Functions
    • Customizing and Styling
      • Custom Components
      • Custom CSS
      • Custom Components
      • Page Pre-loaders
      • Favicon
    • Design Patterns and Best Practices
      • Working with environments
      • Handling Data
      • Saving Data
      • Optimization
      • Business Logic
      • UI / UX
  • Security
    • Authentication
    • Security White Paper
    • Firewalls
    • Technology Stack
  • Compatibility
Powered by GitBook
On this page
  • The User object
  • Methods
  • Create a new User
  • Read a User
  • Update a User
  • Delete a User
  • Error Handling

Was this helpful?

  1. Reference
  2. Users & Authentication

Managing User Accounts

Since your BetterForms web users are stored in your helper file, you will need to add the helper file as an external data source for your legacy FileMaker file. This will allow you to run the API scripts provided in the Helper file that help manage users.

Download the BetterForms Demo file for an example FileMaker script that shows you how to call the User API script

The User object

All of the requests below will refer to the user object, which is simply the expected JSON object expected by this API script to represent a user.

{
  "id": "",
  "email": "", //user's email address
  "avatar": "", //URL to an image to be used as an avatar
  "isEnabled": true,
  "isVerified": true
}

Methods

Create a new User

To create a new user, simply pass a JSON object without an id key. isEnabled and isVerified will default false if not set.

The script will return the full object of the user, which will include its new id.

Read a User

To read a user's details, pass in ONLY the id key. No data will be updated, but the full user's object will be returned.

Update a User

To update a user, pass in any key(s) that you want to update AND the id of the user.

Delete a User

To delete a user from the Helper file, pass the user's id AND an additional isDelete flag set to true.

Error Handling

Use the Error.isError custom function to check the script result and ensure that is ran properly.

PreviousUsers & AuthenticationNextCustom Login Pages

Last updated 3 years ago

Was this helpful?