Skip to content

Auth model reference

The auth-model field in a connection's configuration selects the authentication method. The keys you put in auth-properties depend on the selected model.

Note

auth-properties only appears in data-sources.json when you pre-configure credentials manually. After the first connection with save-password: true, dbvr encrypts the credentials and removes auth-properties from the file. In a working connection you'll only see auth-model — the credentials are in the encrypted store.

Tip

To pre-configure credentials in data-sources.json so connections authenticate automatically, see Pre-configure credentials.

How to configure authentication

Here is an example of a common auth model.

To set up username and password authentication, specify the ID that matches your database. Use native for most standard connections like PostgreSQL or MySQL.

Once you select the appropriate ID, add the following fields to your configuration:

Field Description
userName Database username
userPassword Database password

Example

{
  "auth-model": "native",
  "auth-properties": {
    "userName": "postgres",
    "userPassword": "secret"
  }
}

All auth models

For the full list of models available for your driver, run:

dbvr auth-models --driver=<driver-id>