ee.data.authenticateViaPrivateKey

  • Enables server-side authentication for Earth Engine API calls using a private key, suitable for non-browser environments.

  • Authentication happens automatically for asynchronous calls, but synchronous calls require manual token checks and refresh using ee.data.getAuthToken() and ee.data.refreshAuthToken().

  • ee.data.authenticateViaPrivateKey() function facilitates this authentication process, accepting the private key and optional success/error callbacks, extra scopes, and a flag to suppress default scopes.

Configures server-side authentication of EE API calls through the Google APIs Node.js Client. Private key authentication is strictly for server-side API calls: for browser-based applications, use ee.data.authenticateViaOauth(). No user interaction (e.g. authentication popup) is necessary when using server-side authentication.

This or another authentication method should be called before ee.initialize().

The auth token will be refreshed automatically when possible. You can safely assume that all async calls will be sent with the appropriate credentials. For synchronous calls, however, you should check for an auth token with ee.data.getAuthToken() and call ee.data.refreshAuthToken() manually if there is none. The token refresh operation is asynchronous and cannot be performed behind-the-scenes, on demand, prior to synchronous calls.

UsageReturns
ee.data.authenticateViaPrivateKey(privateKey, success, error, extraScopes, suppressDefaultScopes)
ArgumentTypeDetails
privateKeyAuthPrivateKeyJSON content of private key.
successFunction, optionalThe function to call if authentication succeeded.
errorFunction, optionalThe function to call if authentication failed, passed the error message.
extraScopesList<String>, optionalExtra OAuth scopes to request.
suppressDefaultScopesBoolean, optionalWhen true, only scopes specified in opt_extraScopes are requested; the default scopes are not not requested unless explicitly specified in opt_extraScopes.