auth models

Table of contents

• Synopsis
• Description
• Options
  • --datasource
  • --driver
  • --project
  • --provider
• Example

auth-models - list supported database authentication models in dbvr.

Synopsis

dbvr auth-models [-hV]
                 [--datasource=<datasourceId>]
                 [--driver=<driverId>]
                 [--project=<projectIdOrName>]
                 [--provider=<providerId>]

Tip: You can also use global options with this command.

Description

List available database authentication models.

Authentication models define how credentials are provided to a database - for example username/password, Kerberos, IAM, OAuth, or key-based authentication.

For each model, the output includes:

• Authentication model ID
• Name and description
• Supported parameters, if defined

Use this command to identify the correct --auth-model value and required parameters before configuring a datasource with datasource create or datasource update.

Options

--datasource

--datasource=<datasourceId>

Filter authentication models by datasource ID or name.

Use datasource list to find available datasource IDs or Names.

--driver

--driver=<driverId>

Filter authentication models by driver ID. The value must match an existing driver.

Run driver list to see available drivers. Use the Driver ID value. You can also check the full list of databases and their driver IDs in Databases support.

--project

--project=<projectIdOrName>

Filter authentication models by project name or ID.

Use project list to see available projects.

--provider

--provider=<providerId>

Filter authentication models by provider ID.

Use driver list to identify provider IDs shown in the output grouped by provider.

Example

dbvr auth-models --driver=postgres-jdbc

Sample output:

Auth Model ID: native, Name: Username/password, Description: Database authentication (username/password)
Applicable Drivers: PostgreSQL
Parameters:
  - userName = User name
  - userPassword = User password
  - krbUserName = Kerberos user name
  - kdcServer = KDC server
  - useKeytab = true/false
  - krbRealmName = Realm name
  - cacheFilePath = cacheFilePath
  - krb5ConfPath = Kerberos config path
  - keytabPath = Keytab path
  - useKinit = true/false