Interface: AuthClient
WorkspaceClient-shaped Databricks authentication facade.
Extends
Section titled “Extends”DatabricksAuthClientInfo
Properties
Section titled “Properties”accountId?
Section titled “accountId?”
optionalaccountId?:string
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.accountId
authType
Section titled “authType”authType:
"databricks-cli"|"oauth-m2m"|"pat"|"app_obo"|"app_sp"|"runtime"
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.authType
host:
string=options.normalizedUrlSchema
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.host
principal
Section titled “principal”principal:
string
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.principal
profile?
Section titled “profile?”
optionalprofile?:string
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.profile
target
Section titled “target”target:
"workspace"|"account"|"unified"=targetKindSchema
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.target
workspaceId?
Section titled “workspaceId?”
optionalworkspaceId?:string
Inherited from
Section titled “Inherited from”DatabricksAuthClientInfo.workspaceId
Methods
Section titled “Methods”headers()
Section titled “headers()”headers(
options?):Promise<Record<string,string>>
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Record<string, string>>
logout()
Section titled “logout()”logout():
Promise<void>
Returns
Section titled “Returns”Promise<void>
token()
Section titled “token()”token(
options?):Promise<AccessToken>
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<AccessToken>