OAuthGrantType Property

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

Syntax

[VB.NET]
Public Property OAuthGrantType As ApiclientOAuthGrantTypes

[C#]
public ApiclientOAuthGrantTypes OAuthGrantType {get; set;}


enum ApiclientOAuthGrantTypes {
  ogtAuthorizationCode,
  ogtImplicit,
  ogtPassword,
  ogtClientCredentials
}

Remarks

This property 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:

• ogtAuthorizationCode (Authorization Code - Default)
• ogtImplicit (Implicit)
• ogtPassword (Resource Owner Password Credentials)
• ogtClientCredentials (Client Credentials)

The Authorization Code grant is the most commonly used grant type.

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:

• OAuthClientId
• OAuthClientSecret
• OAuthServerAuthURL

Before calling SendRequest (or querying OAuthToken).

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:

• OAuthClientId to the username of the resource owner
• OAuthClientSecret to the password of the resource owner
• OAuthServerAuthURL

Before calling SendRequest (or querying OAuthToken).

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:

• OAuthClientId
• OAuthClientSecret
• OAuthServerAuthURL

Before calling SendRequest (or querying OAuthToken).

Default Value

0