IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

Authorize Method

Authenticates the class with the server using the current application key and Id.

Syntax

backblazeb2.authorize([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method authenticates the class with the server using the values held by ApplicationKey and ApplicationKeyId. A successful call to this method will clear and repopulate the following:

  • Account* properties
  • APIURL configuration setting
  • DownloadURL configuration setting
  • FragmentSize configuration setting (if necessary; refer to its documentation for more information)
  • SimpleUploadLimit configuration setting (if necessary; refer to its documentation for more information)

The class must authenticate with the server before any other requests can be attempted; the class will call it automatically if necessary. As part of the authentication process, the server returns an authorization token which must be used to authorize all further requests; this token is valid for up to 24 hours. When it expires, this method must be called again.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Node.js Edition - Version 20.0 [Build 8265]