Skip to content
dbx tools

Variable: DatabricksAuthOptionsSchema

const DatabricksAuthOptionsSchema: ZodObject<{ accessToken: ZodOptional<ZodString>; accessTokenHeader: ZodOptional<ZodString>; accountId: ZodOptional<ZodString>; auth: ZodOptional<ZodObject<{ lockTimeoutMs: ZodDefault<ZodCoercedNumber<number>>; loginTimeoutMs: ZodDefault<ZodCoercedNumber<number>>; refreshBufferMs: ZodDefault<ZodCoercedNumber<number>>; }, $strict>>; authType: ZodOptional<ZodEnum<{ app_obo: "app_obo"; app_sp: "app_sp"; databricks-cli: "databricks-cli"; oauth-m2m: "oauth-m2m"; pat: "pat"; }>>; clientId: ZodOptional<ZodString>; clientSecret: ZodOptional<ZodString>; configFile: ZodOptional<ZodString>; groupId: ZodOptional<ZodString>; host: ZodOptional<ZodString>; preferUserToMachine: ZodOptional<ZodBoolean>; profile: ZodOptional<ZodString>; requestHeaders: ZodOptional<ZodRecord<ZodString, ZodString>>; scopes: ZodOptional<ZodArray<ZodString>>; target: ZodOptional<ZodEnum<{ account: "account"; unified: "unified"; workspace: "workspace"; }>>; workspaceId: ZodOptional<ZodString>; }, $strict>

DatabricksAuthOptions fields

Section titled “DatabricksAuthOptions fields”

Databricks profile and credential-source options.

  • profile (optional): Databricks CLI profile.
  • host (optional): Databricks host.
  • accountId (optional): Databricks account ID.
  • workspaceId (optional): Databricks workspace ID.
  • configFile (optional): Databricks CLI config file.
  • clientId (optional): Databricks OAuth client ID.
  • clientSecret (optional): Databricks OAuth client secret.
  • accessToken (optional): Databricks access token.
  • groupId (optional): Databricks group ID.
  • authType (optional): Databricks authentication type.
  • scopes (optional): OAuth scopes.
  • target (optional): OAuth target.
  • auth (optional): Token lifecycle overrides.
  • auth.refreshBufferMs (optional): Token refresh buffer in milliseconds.
  • auth.lockTimeoutMs (optional): Credential lock timeout in milliseconds.
  • auth.loginTimeoutMs (optional): Browser login timeout in milliseconds.
  • requestHeaders (optional): Additional authentication request headers.
  • accessTokenHeader (optional): Request header carrying a bearer access token.
  • preferUserToMachine (optional): Prefer a matching user profile over selected machine credentials.