updated docs

bcgov · Feb 25, 2021 · 6026f25 · 6026f25
1 parent f7fff35
commit 6026f25
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/docs/docs/api/subscription.md b/docs/docs/api/subscription.md
@@ -95,7 +95,7 @@ The API operates on following subscription data model fields:
   <tr>
     <td>
       <p class="name">userId</p>
-      <p class="description">user id. Auto-populated from SiteMinder header for SiteMinder authenticated user requests.</p>
+      <p class="description">user id. Auto-populated for authenticated user requests.</p>
     </td>
     <td>
       <table>
@@ -363,7 +363,7 @@ POST /subscriptions
   }
   ```
 
-  For non-admin request, the field _confirmationRequest_ is removed from response, and field _userId_ is populated from SiteMinder header if request is authenticated:
+  For non-admin request, the field _confirmationRequest_ is removed from response, and field _userId_ is populated if request is authenticated:
 
   ```json
   {

diff --git a/docs/docs/getting-started/installation.md b/docs/docs/getting-started/installation.md
@@ -33,7 +33,8 @@ installing from source code is preferred.
   - A SMS service provider account if needs to enable SMS channel. The supported service providers are
     - Twilio (default)
     - Swift
-  - SiteMinder, if need to allow authenticated user request
+  - SiteMinder, if need to allow SiteMinder authenticated user request
+  - OIDC provide, if need to allow OIDC authenticated user request
 - Network and Permissions
   - Minimum runtime firewall requirements:
     - outbound to your ISP DNS server

diff --git a/docs/docs/getting-started/overview.md b/docs/docs/getting-started/overview.md
@@ -8,7 +8,7 @@ _NotifyBC_ is a general purpose API Server to manage subscriptions and dispatch
 
 ## Features
 
-_NotifyBC_ facilitates both anonymous and SiteMinder authentication-enabled secure webapps implementing notification feature. A _NotifyBC_ server instance supports multiple notification services. A service is a topic of interest that user wants to receive updates. It is used as the partition of notification messages and user subscriptions. A user may subscribe to a service in multiple push delivery channels allowed. A user may subscribe to multiple services. In-app pull notification doesn't require subscription as it's not intrusive to user.
+_NotifyBC_ facilitates both anonymous and authentication-enabled secure webapps implementing notification feature. A _NotifyBC_ server instance supports multiple notification services. A service is a topic of interest that user wants to receive updates. It is used as the partition of notification messages and user subscriptions. A user may subscribe to a service in multiple push delivery channels allowed. A user may subscribe to multiple services. In-app pull notification doesn't require subscription as it's not intrusive to user.
 
 ### notification