Cloud Mail 2020 Node.js Edition

Questions / Feedback?

GrantType Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

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

Possible Values

  0 (ogtAuthorizationCode), 
  1 (ogtImplicit), 
  2 (ogtPassword), 
  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

This setting specifies the type of grant to obtain. In most cases the Authorization Code grant type (default) is used, so it is typically not necessary to change this. The supported values are:

  • 0 (Authorization Code - Default)
  • 1 (Implicit)
  • 2 (Resource Owner Password Credentials)
  • 3 (Client Credentials)

For all grant types listed set ClientProfile to Application.

The Authorization Code grant is the most commonly used grant type. It follows the flow described for the Application Client Type section in the OAuth introduction page.

Implicit grants are similar to Authorization Code, except that a Bearer token is returned directly from the authorization server without requiring a second step to exchange a code for a bearer token. To use this grant type set:

And call GetAuthorization.

The Resource Owner Password Credentials grant type may be used to authenticate on behalf of a resource owner with the owner's credentials. Authentication is performed directly and the user is not prompted to authenticate the application. To use this grant type set:

And call GetAuthorization.

The Client Credentials grant type is typically used for server-to-server authentication. The client authenticates directly to the authentication server and receives a token without any user interaction. To use this grant type set:

And call GetAuthorization.

Data Type

Integer

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
Cloud Mail 2020 Node.js Edition - Version 20.0 [Build 7718]