Purpose

Specifies whether the driver fetches access and refresh tokens at connection when OAuth 2.0 Authorization Code Grant is enabled (OAuth2-AuthorizationCode). When this property is enabled, the driver launches the login prompt for your service at connection, which allows you to specify your login credentials and initiate the dynamic authorization code grant flow. Enabling this property provides a method of fetching access and refresh tokens without using the Configuration Manager or third-party tool.

Valid Values

true | false

Behavior

If set to false, the driver does not launch the login prompt for your service. If access and refresh tokens are needed for your authentication flow, you will need to fetch them using the Configuration Manager or another tool.

If set to true, the driver opens the login prompt for your service when attempting to connect. Submitting user and password credentials via the prompt initiates the dynamic authorization code grant to fetch access and refresh tokens.

Notes

  • This property is used only for the dynamic authorization code grant flow. See "Dynamic authorization code grant" for a full list of requirements.

  • When this property is enabled, the value of the RedirectURI property must include the port number. For example, RedirectURI=http://localhost:80 or RedirectURI=http://localhost:8080.

Data Source Methods

public Boolean getEnableLoginPrompt()

public void setEnableLoginPrompt(Boolean)

Default Value

false

Data Type

Boolean