Attribute

EnableLoginPrompt (elp)

Purpose

Specifies whether the driver fetches access and refresh tokens at connection when OAuth2.0 is enabled (AuthenticationMethod=OAuth2). When this option 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 option provides a method of fetching access and refresh tokens without using the Configuration Manager or a third-party tool.

Valid Values

0 | 1

Behavior

If set to 0 (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 a third-party tool.

If set to 1 (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 option is used only for the dynamic authorization code grant flow. See "Dynamic authorization code grant" for a full list of requirements.

  • This option is supported only when the SQL Engine is running in direct mode (SQLEngineMode=2).

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

Default Value

0 (false)

See Also