Skip to content

Commit

Permalink
docs: update clientId explanation (#1559)
Browse files Browse the repository at this point in the history
  • Loading branch information
mShan0 authored Jul 25, 2023
1 parent 832d88f commit 54727ad
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
7 changes: 5 additions & 2 deletions api-connection.html
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,11 @@ <h2 id="function_newConnection">new Connection(config)</h2>
<ul>
<li>username (string): A user needs to provide the `userName` associated to their account.</li>
<li>password (string): A user needs to provide the `password` associated to their account.</li>
<li>clientId (string): Application (`client`) ID from your registered Azure application. This currently is optional
and uses a default clientId, but a user-provided clientId will be required in the near future.
<li>clientId (string): Application (`client`) ID from your registered Azure application.
The application has to have public client flows enabled and has to have `user_impersonation`
permissions for Azure SQL Database. The user account that is being used also has to be assigned
to the application, and has to grant consent (either explicitly or via admin consent).
Note: the previously provided default client ID will expire in the near future and stop working.
</li>
<li>tenantId (string): Optional parameter for specific Azure tenant ID. (default: <code>common</code>).
If your server does not support the <code>/common</code> endpoint, please provide a tenantId.
Expand Down
11 changes: 11 additions & 0 deletions frequently-encountered-problems.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,17 @@ <h3>Tedious Configurations</h3>

</dd>
<br />
<dt>
<h2>Providing a client ID when using <code>azure-active-directory-password</code></h2>
</dt>
<dd>
<p>The clientId field is now mandatory when using the <code>azure-active-directory-password</code> authentication type.</p>
<p>Microsoft-owned drivers have a default hard-coded client ID. Because Tedious is NOT a Microsoft-owned driver,
the previously provided default client ID has been removed from Tedious. It will expire in the near future and stop working.</p>
<p>Please refer to the <a href="https://tediousjs.github.io/tedious/api-connection.html#function_newConnection">connection</a>
API documentation for more information and alternate Azure connection methods.</p>
</dd>
<br />
<dt>
<h2>Remote Azure Connection</h2>
</dt>
Expand Down

0 comments on commit 54727ad

Please sign in to comment.