Appfarm Documentation
Getting startedDocumentationCommunityAppfarm Create
  • Overview
  • Getting Started
    • What is Appfarm?
    • Key concepts
    • Quickstart
      • Speed intro
      • Step-by-step guide
    • Appfarm Showroom
    • FAQ
  • Appcademy
    • Learning paths
    • Appfarm Fundamentals
      • Intro Course
        • 1. Intro to No-Code and Appfarm
        • 2. Navigation in Appfarm Create
        • 3. What is Apps?
        • 4. Intro to UI Editor
        • 5. Data Model
        • 6. App Data
        • 7. Actions
        • 8. Tips and Tricks
        • 9. Intro to practical walkthrough
        • 10. Create a details view of a Project
        • 11. Create a Custom List
        • 12. Swipe and Delete
        • 13. Functionality for simple Create of Data
        • 14. Upload and Download Photos
        • 15. Input Dialog with Validation and Save
        • 16. Dashboard
        • 17. Summary
        • Quiz
      • User Interface Fundamentals
        • Container - Sectioning, Styling and Repeating
        • Conditional Styles
        • Motions
        • Responsive Design
        • Step-by-step workflow
        • Featured UI Components
        • Quiz
      • App Data Fundamentals
        • Data Source Filtering
        • App Variables and Runtime Properties
        • URL Parameters
        • Quiz
      • Actions & Logic Fundamentals
        • Event Handlers
        • Featured Action Nodes
        • Context Parameters
        • Quiz
      • Services Fundamentals
        • Introduction to Services
        • Setting up a Service
        • Scheduling a Service
      • Integration Fundamentals
        • The web request action node
        • Fetch data from an endpoint
        • Map data to a data source
        • Modify the response
        • Nested data mapping
        • Path parameters
        • Authentication
        • Send data to an endpoint
        • Quiz
      • User handling and permissions
        • Users and roles
        • Permissions
        • Creating users
        • Extending the User object class
        • Updating and deleting users
        • Unauthenticated access
        • Quiz
    • Appfarm Professional
      • User Interfaces
        • Featured UI Components
        • Concepts and Use Cases
      • Data Structures & Data Handling
        • Data Features
        • Search & Filters
        • Featured Action Nodes
        • GraphQL
      • Logic & Flow
        • Logical Concepts
        • Date and Time Handling
        • Featured Action Nodes
        • Exception Handling
      • Login & Configuration
        • Login and Authentication
        • Settings, Configuration and Languages
      • Security & Operations
        • Security and Permissions
        • Deployment
        • Schedules and Logs
        • Debugging and App Health
      • Performance & Optimization
        • Optimizing Performance
        • Enhancing Functionality
    • Appfarm Sales Representative
    • Appfarm Developer Forum
      • Session 1: Data Modeling in Appfarm Create
      • Session 2: App Data in Appfarm Create
      • Session 3: Services in Appfarm Create
      • Session 4: Optimizing Performance
    • Background
      • Databases
        • Data modeling 101
        • Database normalization
  • Library
    • UI components
      • Advanced bar chart
      • Advanced bubble chart
      • Advanced combined chart
      • Advanced gantt chart
      • Advanced heatmap chart
      • Advanced line/area chart
      • Advanced pie chart
      • Advanced scatter plot chart
      • Advanced solid gauge chart
      • Animated component
      • Avatar
      • Avatar group
      • Basic bar chart
      • Basic gauge chart
      • Basic line chart
      • Basic pie chart
      • Bottom navigation
      • Button
      • Checkbox
      • Chip group
      • Circular progress
      • Coded component
      • Container
      • Date & time picker
      • Drawable canvas
      • Floating action button
      • Icon
      • Icon button
      • Iframe
      • Image
      • Linear progress
      • List
      • Map
      • Menu list
      • Multi select
      • PDF reader
      • Popover
      • Radio buttons
      • Rich text editor
      • Rich text
      • Select
      • Slider
      • Speed dial
      • Switch
      • Table
      • Tabs
      • Text
      • Text edit
      • View container
      • Visibility group
    • Action nodes
      • Aggregate data
      • Advanced search
      • Auth operations
      • Block
      • Catch exception
      • Copy to clipboard
      • Create file archive
      • Create file object
      • Create object
      • Create user account
      • Delete objects
      • Delete user account
      • Duplicate objects
      • End execution
      • Exit block
      • Exit loop
      • Export data
      • Foreach
      • Generate document
      • If
      • Import data
      • Invalidate cache
      • Log in
      • Log to console
      • Log out
      • Next iteration
      • Navigate
      • Open/close popover
      • Open confirm dialog
      • Open print dialog
      • Open snackbar
      • Open Unsplash dialog
      • Open URL
      • Persist objects
      • Push notifications
      • Read objects
      • Request permissions
      • Run code
      • Run other action
      • Run service
      • Scan barcode/QR code
      • Send email
      • Send SMS
      • Set client language
      • Set data source attributes
      • Set selection
      • Set theme
      • Set user account image
      • Show install app prompt
      • Sleep
      • Sort objects
      • Throw exception
      • Toggle drawer
      • Update object
      • Update secret
      • Update user account
      • Web request
      • While
  • Reference
    • Appfarm Create
      • Appfarm Commander
      • Blue dots
      • Copy & Paste
      • Farmer's Market
      • Find references
      • Find usage
      • Keyboard shortcuts
      • Undo/Redo
      • User preferences
    • Platform concepts
      • Conditions
      • Data bindings
      • Date and time
      • Event handlers
      • Filters
      • Functions
      • Markdown
      • Objects
      • Operators
      • Value processor
    • Dashboard
    • Apps
      • UI
        • Views
          • Dialog
          • Drawer
        • Layout designer
        • Component properties
        • Shareable UI components
      • Data
        • App variables
        • Data sources
        • Calendar data sources
      • Actions
      • App settings
      • App size
      • App health
    • Services
      • Service Endpoints
      • Service settings
      • Service health
      • API explorer
    • Data model
      • Object classes
      • Object class properties
      • Enumerated types
      • GraphQL
        • Queries
        • Mutations
      • Data Extract API
      • Time series data
    • Operations
      • Deploy
      • Schedules
      • Logs
    • Resources
      • Themes
      • Files
      • Fonts
      • Internationalization
    • Configuration
      • Environments
      • Login
        • Custom auth providers
    • Security
      • Users
      • Service accounts
      • Roles
      • Secrets
      • Permissions
        • Conditional Permissions
    • Appfarm Client
      • Developer tools for Apps
      • Developer tools for Services
      • Warnings and errors
  • How to
    • Data modeling
      • Many-to-many relationships
      • Use naming conventions
      • Offline data handling
      • Data silos and White labelling
    • User interface
      • Manage a many-to-many relationship with a Chip group
      • Configure drag and drop
      • Build a drag-and-drop calendar
      • Design a responsive layout
      • Work with flexbox
      • Use Mapbox as a map layer
      • Understand charts
    • Logic and flow
      • Event Log Design
      • Configure advanced search
    • Themes and styling
      • Change the active theme
      • Add custom email templates
    • Enhance your app
      • Add deep links
      • Add keyboard shortcuts
      • Add link previews for social media
      • Apply SEO best practices
      • Change the active language
      • Generate a PDF from a Container
    • Integrations
      • Integrate with external systems
      • Integrate with OpenAI
      • Integrate with Google Analytics (GA4)
      • Configure a custom email account
      • Integrate with a payment provider
      • Integrate with Signicat
      • Integrate directly with an external database
      • Retrieve a Bearer token from Google Cloud
      • Fetch data from BigQuery
      • Retrieve access token from Microsoft Entra ID
    • Workflow automation
      • Update an OAuth 2.0 access token from a service
    • Authentication and access control
      • Add users and assign roles
      • Configure unauthenticated access
      • Implement third-party authentication
    • Security, testing and deployment
      • Add a custom domain
      • Install an app on a device
      • Get ready for Production
      • Optimize performance
      • Security checklist
      • Test and debug
    • Example apps
      • Create an Instagram clone
        • The end result
        • Designing the feed
        • Create new post
        • Add a like-button
        • Add comment-functionality
  • Solution administration
    • Subscription and billing
    • Dedicated tier benefits
    • Guide to GDPR
      • Key principles
      • How Appfarm protects personal data
      • How you can protect your clients’ data
      • Glossary
    • Appfarm and the EU AI Act
  • Policies
    • Appfarm Policies
    • Data Processors
    • Privacy Policy
Powered by GitBook
On this page
  • General settings
  • Authentication options
  • Custom auth
  • Mail templates

Was this helpful?

Export as PDF
  1. Reference
  2. Configuration

Login

PreviousEnvironmentsNextCustom auth providers

Last updated 11 months ago

Was this helpful?

By editing a login configuration you can define the authentication options for your solution and customize the login experience for your users. It is common to use one configuration that applies to all environments but if you want to enable a different login configuration for an environment, it can be set under .

The login configuration is used for the built-in authentication pages. Additionally, some settings apply to the app listing page that is shown at the root URL of the Appfarm Client when multiple apps are available.

Custom login app

You can build a custom authentication flow by creating a custom login app. As an example, we use a custom app for in the . Note that this custom login app must be an and that it should be defined as the Default App in the .

General settings

Setting
Description

Name

An internal name for this login configuration.

Page Title

Used in the <title> tag and displayed as the title of the browser tab. Defaults to Appfarm.

Favicon

Logo

Info Text

Text displayed below the logo on the login page.

App

An app to use for a custom authentication flow, replacing the built-in authentication pages.

Theme

Background Color

Setting a background color will overwrite the background color from a theme.

Background Image

Background Gradient

Authentication options

Setting
Description

Password Login

Enable login with a password set by the user.

Login Link

Enable passwordless login where a "magic link" is sent to the user's email address. After clicking this link logs the user in.

One Time Password Login

Enable one-time password login where a 6-digit code is sent to the user's email address. After entering this code the user is logged in.

Google

Enable Sign In With Google.

Custom Auth

Onboarding URL

A URL where a user can create a user account. Must be a full URL including the protocol, for example https://onboarding.appfarm.io.

When a value is entered, the following text is displayed on the login page: "Don't have an account? Sign Up". Sign Up is linked to the provided onboarding URL.

Disable iOS Fullscreen

Currently, the implementation of Progressive Web Apps on Apple devices has limitations. Some authentication methods like OAuth (Google, Facebook, Microsoft Entra ID) and login links will not work in combination with fullscreen usage. In that case, fullscreen should be disabled.

Custom auth

Setting
Description

Name

A reference for the configuration.

Enabled

Enable users to authenticate using this configuration.

Hide Login Button

Button Text

The text shown on the button on the login page to start authentication. If not specified, Name is used.

Provider

Mail templates

Emails are sent to users in conjunction with standard user authentication operations. The details and content of those emails can be customized. The following emails can be customized:

  • Reset password

  • Welcome

  • Login link

  • One time password

Important

Setting
Description

From Display Name

The name of the sender. Defaults to Appfarm.

Reply-To Address

Subject

This should be edited and mention your company/product name. The default subjects reference Appfarm.

Text Body Template

A plain text email body. The following parameters can be used within the text to dynamically populate data:

  • {{firstName}}

  • {{lastName}}

  • {{resetLink}} (Reset password and welcome emails)

  • {{loginLink}} (Welcome and login link emails)

  • {{oneTimePassword}} (One time password email)

  • {{email}}

  • {{hostName}}

HTML Body Template

A HTML email body. The text body must be populated for a custom HTML body to be used. The same parameters for populating dynamic data are available.

A 16x16 or 32x32 pixel image used as the icon in the browser tab. Must be uploaded to . Defaults to the Appfarm rocket.

Displayed on the login page. Must be uploaded to . Defaults to the Appfarm logo.

The app you select must be configured for unauthenticated access. The authentication options available in your app, configured using the action node, must be enabled under .

A to apply to customize buttons and fonts.

Selecting a background image will reveal further options for how the image should be applied. The image is applied in addition to the background color. Must be uploaded to .

CSS to generate a . Setting a background gradient will overwrite any other background settings. Example values: - linear-gradient(#e66465, #9198e5) - linear-gradient(70deg, blue, pink) - radial-gradient(rgba(230, 100, 101, 0.9), rgba(145, 152, 229, 0.7))

Add a

The URL could be for an or an external site.

Appfarm supports custom authentication providers such as Microsoft Entra ID (Azure AD). A provider should first be configured under and then added within the login configuration. Each custom auth provider configuration has the following settings.

Do not display the login button on the built-in login page. Instead you can use a unique URL which can be found under the next to this option in Appfarm Create. This option can be useful if you have a for unauthenticated users as the entry point (with login features). Example: Clicking the blue dot, you find the following URL https://HOST_NAME/auth/v1/authorize?auth_selector=custom&id=W80Mpo In your App for Login, you may have a button for login, with an action with an Open URL action node as below: Note that in this case, we have an App Variable holding the relative path where we want to user to be navigated to after login.

Assign a .

You can find examples of custom templates under .

All authentication emails sent by Appfarm are sent from . It is not possible to change this email address.

Unless anything is specified in this setting, the reply-to email for login-related emails is . You should, if possible, add another email address here for handling end-customer-related support cases.

Custom auth providers
Email templates
security@appfarm.io
Files
Files
theme
Files
background gradient
unauthenticated app
custom auth provider
security@appfarm.io
Auth Operations
Authentication options
custom authentication provider configuration.
Environments
sign up and login
Showroom
Unauthenticated App
blue dot
Environments Config
default app