OptionalactiveCredentialSource
activeCredentialSource?: "user" | "svcacct" | "amster" | "browser"
OptionaladminClientId
adminClientId?: string
OptionaladminClientRedirectUri
adminClientRedirectUri?: string
Optionalalias
alias?: string
OptionalallowInsecureConnection
allowInsecureConnection?: boolean
OptionalamBearerTokenAcceptanceProbed
amBearerTokenAcceptanceProbed?: boolean
OptionalamCredentialProvider
OptionalamsterPrivateKey
amsterPrivateKey?: string
OptionalamVersion
amVersion?: string
authenticationHeaderOverrides?: Record<string, string>
OptionalauthenticationService
authenticationService?: string
OptionalauthMode
authMode?: "noninteractive" | "interactive"
OptionalautoRefreshTimer
autoRefreshTimer?: Timeout
OptionalaxiosRetryConfig
axiosRetryConfig?: IAxiosRetryConfig
OptionalbrowserLoginClientId
browserLoginClientId?: string
OptionalbrowserLoginScope
browserLoginScope?: string
OptionalcallerTrustTier
callerTrustTier?: "full-trust" | "delegated"
OptionalcallerTrustTierResolver
OptionalcolorTheme
colorTheme?: "dark" | "light"
configurationHeaderOverrides?: Record<string, string>
OptionalconnectionProfilesPath
connectionProfilesPath?: string
OptionalcookieName
cookieName?: string
OptionalcreateProgressHandler
Optionalcurlirize
curlirize?: boolean
OptionalcurlirizeHandler
curlirizeHandler?: (message: string) => void
Optionaldebug
debug?: boolean
OptionaldebugHandler
debugHandler?: (message: string | object) => void
OptionaldefaultCredential
defaultCredential?: "user" | "svcacct" | "amster"
OptionaldeploymentType
deploymentType?: string
Optionaldirectory
directory?: string
Optionalenv
env?: Record<string, string>
OptionalerrorHandler
errorHandler?: (error: Error, message: string) => void
OptionalfrodoVersion
frodoVersion?: string
Optionalhost
host?: string
OptionalidmHost
idmHost?: string
OptionalidmVersion
idmVersion?: string
OptionalidToken
idToken?: string
OptionalisIGA
isIGA?: boolean
OptionalisPingFed
isPingFed?: boolean
OptionallogApiKey
logApiKey?: string
OptionallogApiSecret
logApiSecret?: string
OptionalmasterKeyPath
masterKeyPath?: string
OptionalneedsReauthentication
needsReauthentication?: boolean
OptionaloutputFile
outputFile?: string
Optionalpassword
password?: string
OptionalprintHandler
printHandler?: (
message: string | object,
type?: string,
newline?: boolean,
) => void
OptionalprivilegeEscalationHandler
privilegeEscalationHandler?: () => Promise<boolean>
Optionalrealm
realm?: string
OptionalrefreshToken
refreshToken?: string
OptionalserviceAccountId
serviceAccountId?: string
OptionalserviceAccountJwk
OptionalserviceAccountScope
serviceAccountScope?: string
OptionalstopProgressHandler
stopProgressHandler?: (id: string, message: string, status?: string) => void
OptionaltokenCachePath
tokenCachePath?: string
OptionaltokenRefreshHandler
OptionalupdateProgressHandler
updateProgressHandler?: (id: string, message: string) => void
OptionaluseBearerTokenForAmApis
useBearerTokenForAmApis?: boolean
OptionaluseRealmPrefixOnManagedObjects
useRealmPrefixOnManagedObjects?: boolean
Optionalusername
username?: string
OptionaluseTokenCache
useTokenCache?: boolean
Optionalverbose
verbose?: boolean
OptionalverboseHandler
verboseHandler?: (message: string | object) => void