Skip to content

Commit 77a778e

Browse files
committed
Update documentation links and formatting
1 parent 09b4709 commit 77a778e

File tree

2 files changed

+40
-38
lines changed

2 files changed

+40
-38
lines changed

doc/src/api_manual/oracledb.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3744,11 +3744,12 @@ Oracledb Methods
37443744

37453745
The tenantId is the directory tenant the application plans to operate against in GUID or domain-name format.
37463746

3747-
Some of the common authority URLs are:
3748-
https://login.microsoftonline.com/<tenant>/
3749-
https://login.microsoftonline.com/common/
3750-
https://login.microsoftonline.com/organizations/
3751-
https://login.microsoftonline.com/consumers/
3747+
Some of the common authority URLs are::
3748+
3749+
https://login.microsoftonline.com/<tenant>/
3750+
https://login.microsoftonline.com/common/
3751+
https://login.microsoftonline.com/organizations/
3752+
https://login.microsoftonline.com/consumers/
37523753
- Required
37533754
* - ``clientId``
37543755
- The application ID that is assigned to your application.

doc/src/user_guide/authentication_methods.rst

Lines changed: 34 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -130,19 +130,20 @@ External Authentication
130130
=======================
131131

132132
External Authentication allows applications to use an external password
133-
store (such as an `Oracle Wallet <https://www.oracle.com/pls/topic/lookup?
134-
ctx=dblatest&id=GUID-E3E16C82-E174-4814-98D5-EADF1BCB3C37>`__),
135-
the `Transport Layer Security (TLS) or Secure Socket Layer (SSL)
136-
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-6AD89576-526F-
137-
4D6B-A539-ADF4B840819F>`__, or the `operating system <https://www.oracle.com/
138-
pls/topic/lookup?ctx=dblatest&id=GUID-37BECE32-58D5-43BF-A098-97936D66968F>`__
139-
to validate user access. With an external password store, your application can
140-
use an Oracle Wallet to authenticate users. External Authentication using TLS
141-
authenticates users with Public Key Infrastructure (PKI) certificates. With
142-
operating system authentication, user authentication can be performed if the
143-
user has an operating system account on their machine recognized by Oracle
144-
Database. One of the benefits of using external authentication is that
145-
database credentials do not need to be hard coded in the application.
133+
store (such as an `Oracle Wallet <https://docs.oracle.com/en/database/oracle/
134+
oracle-database/21/dbimi/using-oracle-wallet-manager.html#GUID-E3E16C82-E174-
135+
4814-98D5-EADF1BCB3C37>`__), the `Transport Layer Security (TLS) or Secure
136+
Socket Layer (SSL) <https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=
137+
GUID-6AD89576-526F-4D6B-A539-ADF4B840819F>`__, or the `operating system
138+
<https://www.oracle.com/pls/topic/lookup?ctx=dblatest&id=GUID-37BECE32-58D5-
139+
43BF-A098-97936D66968F>`__ to validate user access. With an external password
140+
store, your application can use an Oracle Wallet to authenticate users.
141+
External Authentication using TLS authenticates users with Public Key
142+
Infrastructure (PKI) certificates. With operating system authentication, user
143+
authentication can be performed if the user has an operating system account on
144+
their machine recognized by Oracle Database. One of the benefits of using
145+
external authentication is that database credentials do not need to be hard
146+
coded in the application.
146147

147148
.. note::
148149

@@ -522,8 +523,8 @@ following command::
522523

523524
npm install oci-sdk
524525

525-
See `sampleocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
526-
examples/sampleocitokenauth.js>`__ for a runnable example using the OCI SDK.
526+
See `ocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
527+
examples/ocitokenauth.js>`__ for a runnable example using the OCI SDK.
527528

528529
**Token Generation Using extensionOci Plugin**
529530

@@ -577,8 +578,8 @@ application. For example:
577578
... // OCI-specific authentication details
578579
}
579580
580-
See `sampleocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
581-
examples/sampleocitokenauth.js>`__ for a runnable example using the OCI SDK.
581+
See `ocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
582+
examples/ocitokenauth.js>`__ for a runnable example using the OCI SDK.
582583
The use of ``getToken()`` and ``accessTokenConfig`` is shown in subsequent
583584
examples.
584585

@@ -673,8 +674,8 @@ generate tokens in the callback method. For example:
673674
});
674675
}
675676
676-
See `sampleocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
677-
examples/sampleocitokenauth.js>`__ for a runnable example using the OCI SDK.
677+
See `ocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
678+
examples/ocitokenauth.js>`__ for a runnable example using the OCI SDK.
678679
The callback and ``refresh`` parameter descriptions are detailed in the
679680
example above.
680681

@@ -747,8 +748,8 @@ generate tokens in the callback method. For example:
747748
});
748749
}
749750
750-
See `sampleocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
751-
examples/sampleocitokenauth.js>`__ for a runnable example using the OCI SDK.
751+
See `ocitokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
752+
examples/ocitokenauth.js>`__ for a runnable example using the OCI SDK.
752753
See :ref:`IAM Standalone Connections <iamstandalone>` for a description of
753754
the callback and ``refresh`` parameter.
754755

@@ -1033,10 +1034,10 @@ application. For example:
10331034
... // Azure-specific authentication types
10341035
}
10351036
1036-
See `sampleazuretokenauth.js <https://github.com/oracle/node-oracledb/tree/
1037-
main/examples/sampleazuretokenauth.js>`__ for a runnable example using the
1038-
Azure SDK. The use of ``getToken()`` and ``accessTokenConfig`` is shown in
1039-
subsequent examples.
1037+
See `azuretokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
1038+
examples/azuretokenauth.js>`__ for a runnable example using the Azure SDK. The
1039+
use of ``getToken()`` and ``accessTokenConfig`` is shown in subsequent
1040+
examples.
10401041

10411042
**Token Generation Using extensionAzure Plugin**
10421043

@@ -1132,10 +1133,10 @@ generate tokens in the callback method. For example:
11321133
});
11331134
}
11341135
1135-
See `sampleazuretokenauth.js <https://github.com/oracle/node-oracledb/tree/
1136-
main/examples/sampleazuretokenauth.js>`__ for a runnable example using the
1137-
Azure SDK. The callback and ``refresh`` parameter descriptions are detailed
1138-
in the example above.
1136+
See `azuretokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
1137+
examples/azuretokenauth.js>`__ for a runnable example using the Azure SDK. The
1138+
callback and ``refresh`` parameter descriptions are detailed in the example
1139+
above.
11391140

11401141
.. _oauthpool:
11411142

@@ -1206,10 +1207,10 @@ generate tokens in the callback method. For example:
12061207
});
12071208
}
12081209
1209-
See `sampleazuretokenauth.js <https://github.com/oracle/node-oracledb/tree/
1210-
main/examples/sampleazuretokenauth.js>`__ for a runnable example using the
1211-
Azure SDK. See :ref:`OAuth 2.0 Standalone Connections <oauthstandalone>` for a
1212-
description of the callback and ``refresh`` parameter.
1210+
See `azuretokenauth.js <https://github.com/oracle/node-oracledb/tree/main/
1211+
examples/azuretokenauth.js>`__ for a runnable example using the Azure SDK. See
1212+
:ref:`OAuth 2.0 Standalone Connections <oauthstandalone>` for a description of
1213+
the callback and ``refresh`` parameter.
12131214

12141215
.. _oauthconnectstring:
12151216

0 commit comments

Comments
 (0)