Skip to content
dbx tools

Variable: AuthCliOptionsSchema

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

AuthCliOptions fields

Section titled “AuthCliOptions fields”

Options shared by every Databricks auth command.

  • 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.
  • groupId (optional): Databricks group ID.
  • authType (optional): Databricks authentication type.
  • scopes (optional): OAuth scopes.
  • target (optional): OAuth target.
  • lockTimeoutMs (optional): Credential lock timeout in milliseconds.
  • loginTimeoutMs (optional): Browser login timeout in milliseconds.
  • refreshBufferMs (optional): Token refresh buffer in milliseconds.
  • preferUserToMachine (optional): Prefer a matching user profile over selected machine credentials.