SecureBlackbox 2020 Node.js Edition

Questions / Feedback?

GrantType Property

Specifies which protocol flow should be used to authorize the user.

Syntax

 oauthclient.getGrantType([callback])
 oauthclient.setGrantType( grantType, [callback])

Possible Values

  0 (ogtAuthorizationCode), 
  1 (ogtImplicit), 
  2 (ogtPasswordCredentials), 
  3 (ogtClientCredentials)

Default Value

0

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 getGrantType([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 setGrantType([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

Use this property to specify the authorization protocol to use.

ogtAuthorizationCode0Authorization Code flow should be used (see RFC 6749 Section 1.3.1)
ogtImplicit1Implicit flow should be used (see RFC 6749 Section 1.3.2)
ogtPasswordCredentials2Resource Owner Password Credentials flow should be used (see RFC 6749 Section 1.3.3)
ogtClientCredentials3Client Credentials flow should be used (see RFC 6749 Section 1.3.4)

Data Type

Integer

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