Portal Base Project

The Portal Base is an administrative project for your environment.

DO NOT build your forms for your application in the Portal Base project. Instead, go to the home page and create a new project.

The Portal Base project is a special project that is included with a Self-Hosted Environment and is used to control the Portal Application. Utilize this project to control the administrative user base that will authenticate into the environment, Teams to control project permissions, SSO environment, Portal Translations, and more.

This Project contains specific Forms and Resources to help manage your environment. The following section lists all Forms and Resources within this project and what administrative purpose they serve. The Portal Base Project is not counted towards the project limit for a Self Hosted License.

To reinstall the Portal Base Project, delete the project within the Database, and restart the environment container. This process will recreate the Portal Base Project within the environment

Simply deleting the Portal Base Project from the Developer Portal UI (rather than entirely from the DB as described above) and reinstalling it, will inadvertently consume a Project allocation within the license scope.

Portal Base Forms and Resources

The Forms and Resources that are in the Portal Base project govern the Developer Portal Application and its functionality. Below is a list of these Forms and Resources.

User Resource

The User Resource can be leveraged to manually create new User accounts for the Developer Portal Application. Make submissions against this Resource to create your Form.io Developer Portal users. These Users can then use the submitted credentials to log into the Developer Portal Application. Alternatively, the Form.io Developer Portal can be configured to support SSO as described here.

By default, Users created within this Resource will be assigned the Authenticated role which allows these users to create Projects, having full permission rights to read, modify, and delete the projects these users own (created).

Use the following environment variable to remove the User permission for creating projects. ONLY_PRIMARY_WRITE_ACCESS = true Available in API Server version 8.0.0 or later only.

Admin Resource

Use the USER resource to assign permissions to projects, by adding the USER to a team that has whatever Team Permissions are appropriate for the team.

The Admin Resource can be leveraged to manually create new Admin accounts for the Developer Portal Application. Make submissions against this Resource to create your Form.io Developer Portal Admins.

If you have lost access to your Form.io admin portal or need to reset the admin credentials, follow the documentation link below to regain access.

Reset Admin Password for Deployed Portal

By default, Admins created within this Resource will be assigned the Administrator role which grants these users full permission rights to view all projects created within the Form.io Developer Portal. This is not a substitution for Teams. To grant access to projects, use the USER Resource, add those Users to Teams, and assign the Teams to a project with the appropriate access level desired. More described below:

formio-enterprise:8.0.0 and later: When logged in as an Admin, Access permissions are granted to all projects. Access Permissions allow only for the ability to see the Project within the home page. No access is given to read or write anything within that project. Admin users have Access permissions to all projects within the environment, providing visibility and access to the project on the Portal home page. However, Project-level Read, Write, or Admin permissions are not granted. Create a Team if additional Project permissions are needed for Admin Users.

Team and Team Member Resource

Use these Resources to create or manage the Team Members and their associated Teams. Team Member emails are associated with accounts created within the User Resource or emails from an integrated SSO provider.

When creating SSO Teams, ensure you have the correct Environment Variable set

SSO_TEAMS=true

Language Resource

Add and manage Portal Translations inside the environment. Users can change the Portal Language by clicking the Language dropdown in the Portal header and selecting a Language.

PDF Resource

A log of all of the PDFs uploaded to the Environment.

Two-Factor Authentication Forms

Forms that facilitate the Two-Factor Authentication environment process.

User Login Form

The authentication form for the environment

User Registration Form

By default, the Registration Form is disabled for deployed projects as User creation is typically done by using the User Resource. To allow for User Registration on the authentication page, simply add an email and password field to the Registration form.

Click here for more information on the Registration Form setup