Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClientOptions

Hierarchy

  • ClientOptions

Index

Properties

Properties

Optional apiKeyMode

apiKeyMode: undefined | false | true

Retrieve data with apiKey passed at getToken method

appId

appId: string

App identifier (ex: 'FileExtractor')

Optional authentication

authentication: undefined | { credentials?: ClientCredentials; provider?: unknown }

OIDC/API auth

Optional baseUrl

baseUrl: undefined | string

URL to Cognite cluster, e.g 'https://greenfield.cognitedata.com'

Optional getToken

getToken: undefined | (() => Promise<string>)

Can be used with @cognite/auth-wrapper, passing an api key or with MSAL Library

Optional noAuthMode

noAuthMode: undefined | false | true

Retrieve data without any authentication headers

project

project: string

Project name

Optional retryValidator

retryValidator: RetryValidator