AuthorizationScope Property

The authorization scope used during authorization.

Syntax

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

Default Value

"openid"

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

This property specifies the authorization scopes sent in the authorization request. The value specified here must be a space separated list of scopes. For instance openid profile email.

The openid scope is always required to be present. The default value is openid.

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