Authentication

Authentication

The original version of this document is located at https://docs.qfield.org/how-to/advanced-how-tos/authentication

Authentication

QField supports connecting to services requiring access authentication.
This page will go through authentication examples as well as demonstrating how to export authentication configuration from QGIS into QField

OAuth2-protected web services in QGIS

🖥️ Desktop preparation

To successfully load OAuth2-protected layers in QField, these layers must be setup to use OAuth2 in QGIS.
To setup a WFS with OAuth2 in QGIS follow these steps.

Workflow

  1. Direct to Layer > Add Layer > Add WFS / OGC API Feature Service
  2. Click on “New” or “edit” your existing service.
  3. Add a new authentication type by clicking the green cross and adjust the parameters to match your OAuth2 server setup.
  4. Once the layer’s authentication configuration is set, add some layers into your project to test that they are rendering correctly.

WFS Service Settings

Authentication

Export authentication configurations from QGIS

🖥️ Desktop preparation

Prior to exporting authentication configurations, it is always good to verify that you are able to properly connect to relevant services using QGIS.

Workflow

  1. Direct to Settings > Options > Authentication

  2. Select one or more rows in the configurations table widget.

  3. Click on “Utilities” and select “export selected authentication configurations to file”.
  4. When prompted for a password, leave it blank.

QGIS Authentication Settings

Warning

You will be warned that you might be leaking sensitive information, which is a good reminder to treat the resulting XML with caution.

Import authentication configurations into QField

🖥️ Desktop preparation

In order for a service that requires authentication to run in QField, after configuring the required credentials in QGIS, the information needs to be added into QField as well.

Workflow

  1. Export the authentication configuration file from QGIS (see above)
  2. On your device direct to the QField App Directory > Auth
  3. Once copied, the service should be rendered correctly and provide access.

Tip

For authentication methods requiring user input such as OAuth2, QField will provide a browser or dialog to prompting for the required details such as user, password, or 2-step authentication code.

    • Related Articles

    • Authentication

      The original version of this document is located at https://docs.qfield.org/reference/qfieldcloud/auth Authentication QFieldCloud and QField / QFieldSync clients allow authentication using regular username and password, or, if configured, OpenID ...

    • Architecture overview

      The original version of this document is located at https://docs.qfield.org/reference/qfieldcloud/architecture Architecture overview QFieldCloud has a containerized architecture with multiple containers and volumes. See an interactive version of the ...

    • PostgreSQL Databases

      The original version of this document is located at https://docs.qfield.org/how-to/project-setup/pg-service Working with PostgreSQL PostgreSQL in QField Working with databases can be much easier when working in a multi-user environment or when ...

    • Storage

      The original version of this document is located at https://docs.qfield.org/how-to/project-setup/storage QField Storage Management On the QField homescreen, users are presented with two options to open a project. QFieldCloud projects: The first ...