GetAuthorization Method

Gets the authorization string required to access the protected resource.

Syntax

oauth.getAuthorization([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, data){ }

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

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method performs several operations automatically depending on the value of ClientProfile. Please see the introduction section for the OAuth class for a detailed overview of the typical scenarios.

After authorization is completed this method will return the authorization string which can be passed directly to the Authorization property of any other component. This can also be passed as the value of the HTTP Authorization header to other implementations that access the protected resource as well.

RefreshToken will also be populated with the refresh token if one is returned.