AuthorizationScope Property

The scope request or response parameter used during authorization.

Syntax

 oauth.getAuthorizationScope([callback])
 oauth.setAuthorizationScope( authorizationScope, [callback])

Default Value

""

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 the getAuthorizationScope([callback]) 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.

The callback for the setAuthorizationScope([callback]) 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

If the scope is not set, the authorization server will use the default access scope for your application as determined by the server. To request a specific access scope set this property to a space separated list of strings as defined by the authorization server.

After calling GetAuthorization this property will be updated with the scope sent in the response from the server and will indicate the scope that was actually granted.

Data Type

String