Merge pull request #5 from MobileID-Strong-Authentication/docs/fix-reference-guide-typos

Docs/fix reference guide typos

Author: phaupt

docs/.vitepress/config.mts

@@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: 'Mobile ID Documentation',
+  title: 'Mobile ID docs',
   description: 'Technical documentation for Mobile ID integration',
   base: '/',
   lastUpdated: true,
@@ -13,81 +13,77 @@ export default defineConfig({
 
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
-    logo: '/img/mobileid-colors.png',
+    logo: '/img/mobileid-colors-transparent.svg',
     siteTitle: false, // Hide visual title, keep only logo (HTML <title> remains)
 
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'API Reference Guide', link: '/reference-guide/introduction' },
-      { text: 'OIDC Integration', link: '/oidc/introduction' },
-      {
-        text: 'More',
-        items: [
-          { text: 'Release Notes', link: '/release-notes/release-notes' },
-          { text: 'API Specification', link: '/api-reference/api' },
-        ]
-      }
+      { text: 'REST API Guide', link: '/rest-api-guide/introduction' },
+      { text: 'OIDC Integration Guide', link: '/oidc-integration-guide/introduction' },
+      { text: 'Release Notes', link: '/release-notes/release-notes' }
 
     ],
 
     sidebar: {
-      '/reference-guide/': [
+      '/rest-api-guide/': [
         {
           text: 'Reference Guide',
           items: [
-            { text: 'Introduction', link: '/reference-guide/introduction' },
-            { text: 'Application Provider Client Integration', link: '/reference-guide/app-provider-client-integration' },
-            { text: 'Mobile ID API', link: '/reference-guide/mobile-id-api' },
-            { text: 'Best Practices', link: '/reference-guide/best-practices' },
-            { text: 'Auto Activation', link: '/reference-guide/auto-activation' },
-            { text: 'Status and Fault Codes', link: '/reference-guide/status-fault-codes' },
-            { text: 'Root CA Certificates (Trust Anchor)', link: '/reference-guide/root-ca-certs' },
-            { text: 'Create X509 Client Certificates', link: '/reference-guide/create-client-certs' },
-            { text: 'Health Status Microservice', link: '/reference-guide/health-status' }
+            { text: 'Introduction', link: '/rest-api-guide/introduction' },
+            { text: 'Integration Steps', link: '/rest-api-guide/app-provider-client-integration' },
+            { text: 'Mobile ID API', link: '/rest-api-guide/mobile-id-api' },
+            { text: 'Best Practices', link: '/rest-api-guide/best-practices' },
+            { text: 'Auto Activation', link: '/rest-api-guide/auto-activation' },
+            { text: 'Status and Fault Codes', link: '/rest-api-guide/status-fault-codes' },
+            { text: 'Root CA Certificates', link: '/rest-api-guide/root-ca-certs' },
+            { text: 'Create Client Certificates', link: '/rest-api-guide/create-client-certs' },
+            { text: 'Health Status Service', link: '/rest-api-guide/health-status' }
           ]
         },
 
         {
-        text: '',
-          items: [
-            { text: 'Imprint', link: '/reference-guide/imprint.md' },
-            ]
+          text: '',
+          items: [{ text: 'API Specification', link: '/rest-api-guide/api-specification' }]
+        },
+        {
+          text: '',
+          items: [{ text: 'Imprint', link: '/rest-api-guide/imprint.md' }]
         }
 
       ],
-      '/entraid/': [
+      '/entraid-guide/': [
         {
           text: 'EntraID Guide',
           items: [
-            { text: 'Index', link: '/entraid/' },
-            { text: 'One', link: '/entraid/one' },
-            { text: 'Two', link: '/entraid/two' }
+            { text: 'Index', link: '/entraid-guide/' },
+            { text: 'One', link: '/entraid-guide/one' },
+            { text: 'Two', link: '/entraid-guide/two' }
           ]
         }
       ],
 
-      '/oidc/': [
+      '/oidc-integration-guide/': [
         {
           text: 'OIDC Guide',
           items: [
-            { text: 'Introduction', link: '/oidc/introduction' },
-            { text: 'Getting Started', link: '/oidc/getting-started' },
-            { text: 'Best Practices', link: '/oidc/best-practices' },
-            { text: 'Public Cloud Integration Guide', link: '/oidc/cloud-integration-guide' },
-            { text: 'MobileID OIDC - Use Cases', link: '/oidc/oidc-use-cases' },
-            { text: 'Message Formats on the Mobile ID App', link: '/oidc/message-formats' }
+            { text: 'Introduction', link: '/oidc-integration-guide/introduction' },
+            { text: 'Getting Started', link: '/oidc-integration-guide/getting-started' },
+            { text: 'Best Practices', link: '/oidc-integration-guide/best-practices' },
+            { text: 'Public Cloud Integration Guide', link: '/oidc-integration-guide/cloud-integration-guide' },
+            { text: 'MobileID OIDC - Use Cases', link: '/oidc-integration-guide/oidc-use-cases' },
+            { text: 'Message Formats on the Mobile ID App', link: '/oidc-integration-guide/message-formats' }
           ]
         }
       ],
 
 
-      '/rig-radius/': [
+      '/radius-interface-gateway-guide/': [
         {
           text: 'RIG Radius Guide',
           items: [
-            { text: 'Index', link: '/rig-radius/' },
-            { text: 'One', link: '/rig-radius/one' },
-            { text: 'Two', link: '/rig-radius/two' }
+            { text: 'Index', link: '/radius-interface-gateway-guide/' },
+            { text: 'One', link: '/radius-interface-gateway-guide/one' },
+            { text: 'Two', link: '/radius-interface-gateway-guide/two' }
           ]
         }
       ]

docs/entraid/external-auth-methods.md …s/entraid-guide/external-auth-methods.mddocs/entraid/external-auth-methods.md renamed to docs/entraid-guide/external-auth-methods.md docs/entraid/external-auth-methods.md renamed to docs/entraid-guide/external-auth-methods.md

@@ -6,27 +6,20 @@ hero:
   name: "Mobile ID docs"
   text: ""
   tagline: seamless strong multi-factor authentication
-  actions:
-    - theme: brand
-      text: API Reference Guide
-      link: /reference-guide/introduction
-    - theme: alt
-      text: API Specification
-      link: /api-reference/api
 
 features:
-  - title: Getting Started
+  - title: REST API Guide
     icon:
       src: /img/icon-info.svg
       class: feature-icon-info
-    details: Discover the Mobile ID documentation and learn how to secure your application.
-    link: /reference-guide/introduction
+    details: Start here for direct integration via REST API (works for web apps and non-browser flows like native apps/backends).
+    link: /rest-api-guide/introduction
   - title: OIDC Integration Guide
     icon:
       src: /img/icon-security.svg
       class: feature-icon-security
-    details: Follow this guide to integrate Mobile ID into your application through the OpenID Connect (OIDC) standard.
-    link: /oidc/introduction
+    details: Start here for standards-based login via OpenID Connect (browser/redirect flow). Mobile ID acts as the OpenID Provider.
+    link: /oidc-integration-guide/introduction
   - title: Release Notes
     icon:
       src: /img/icon-notes.svg

docs/entraid/getting-started.md docs/entraid-guide/getting-started.mddocs/entraid/getting-started.md renamed to docs/entraid-guide/getting-started.md

@@ -141,7 +141,7 @@ Tokens, especially Refresh Tokens, must be treated as credentials and stored sec
 
 There are test user accounts available for testing and debugging purpose.
 
-Please be aware, due to the strict phone number validation during the Mobile ID authorization flow, these test phone numbers will only be accepted by the Mobile ID server if they are provided via `log-in_hint` request parameter. However, your account must be authorized to use the `login_hint` parameter and requires the use of Pushed Authorisation Requests (PAR), which keeps the parameters confidential between client and server (see section [Pushed Authorization Request (PAR)](/oidc/best-practices#pushed-authorization-request-par) ).
+Please be aware, due to the strict phone number validation during the Mobile ID authorization flow, these test phone numbers will only be accepted by the Mobile ID server if they are provided via `log-in_hint` request parameter. However, your account must be authorized to use the `login_hint` parameter and requires the use of Pushed Authorisation Requests (PAR), which keeps the parameters confidential between client and server (see section [Pushed Authorization Request (PAR)](/oidc-integration-guide/best-practices#pushed-authorization-request-par) ).
 
 | MSISDN | Auth | Description |
 |--------|------|-------------|

docs/entraid/imprint.md docs/entraid-guide/imprint.mddocs/entraid/imprint.md renamed to docs/entraid-guide/imprint.md

@@ -8,8 +8,8 @@ For the technical on-boarding, you will be asked to provide Swisscom with the fo
 |------|--------------------|------|
 | **Client Display Name** | Your client’s name, which is displayed by the authorization server. <br> Example value: `iDemo Online Shop` | |
 | **Redirect URI(s)** | Redirection URI(s) to which the response will be sent. Note that TLS (https) is always required and the localhost URI is not allowed.<br> Example value:<br>`https://app01.idemo-company.ch/oauth2/authresp`<br>`https://app02.idemo-company.ch/oauth2/authresp` | [OIDC spec](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest) |
-| **Default ACR** | Your default ACR. Must be a value that is available for your selected Mobile ID contract.<br> Example value: `mid_al3_any` | [Section Auth Code Request ](/oidc/getting-started#authorization-code-request) |
-| **Client Auth Mode** | Your client’s authentication method, either basic or post.<br> Example value: `client_secret_post` | [Section Access Token Request ](/oidc/getting-started#access-token-request) |
+| **Default ACR** | Your default ACR. Must be a value that is available for your selected Mobile ID contract.<br> Example value: `mid_al3_any` | [Section Auth Code Request ](/oidc-integration-guide/getting-started#authorization-code-request) |
+| **Client Auth Mode** | Your client’s authentication method, either basic or post.<br> Example value: `client_secret_post` | [Section Access Token Request ](/oidc-integration-guide/getting-started#access-token-request) |
 | **Always Prompt For Consent** | The Mobile ID server default behavior is to skip the consent step, provided such is already recorded for the given end-user and client.<br> Default: `false` | |
 | **MFA Number Matching** | Enable MFA number matching feature for Mobile ID SIM and Mobile ID App authentication.<br> When a user responds to an MFA notification using Mobile ID SIM or Mobile ID App, they'll be presented with a number on their mobile. They need to select that number in the sign-in prompt to complete the approval.<br> Default: `false` | [Video](https://youtu.be/4ACfK_kByKY) |
 | **LDAP Settings** | Optional. Mobile ID server can connect to an LDAP(S) to validate user credentials and/or retrieve user attributes from the LDAP, such as:<br> - MFA mobile number attribute<br> - Mobile ID Serialnumber attribute (required for ACR mid_al4)<br> - User password attribute | |
@@ -72,13 +72,13 @@ The following request query string parameters are supported:
 
 | Parameter | Value | Remarks |
 |-----------|-------|---------|
-| scope | MUST contain the value `openid` | Optionally, the client may request additional scopes as specified in [Scopes and Claims](/oidc/getting-started#scopes-and-claims) |
+| scope | MUST contain the value `openid` | Optionally, the client may request additional scopes as specified in [Scopes and Claims](/oidc-integration-guide/getting-started#scopes-and-claims) |
 | response_type | MUST be the value `code` | |
 | client_id | MUST be your client ID | |
 | redirect_uri | MUST be (one of) your redirect URI(s) | |
 | state | MUST be an opaque value | Used to maintain state between the request and the callback |
 | nonce | MUST be a nonce value | |
-| acr_values | CAN be set to overwrite the client's default ACR | Authentication Level (AL) required by the client (see [ACR](/oidc/getting-started#authentication-context-class-reference-acr)) |
+| acr_values | CAN be set to overwrite the client's default ACR | Authentication Level (AL) required by the client (see [ACR](/oidc-integration-guide/getting-started#authentication-context-class-reference-acr)) |
 | response_mode | SHALL NOT be used | |
 | display | SHALL NOT be used | |
 | prompt | CAN be set to `login` | |
@@ -152,7 +152,7 @@ If a user has more than one authentication method available that comply with the
 | 3 | Unknown SIM card & Active Mobile ID App | Mobile ID App |
 | 4 | Unknown SIM card & Inactive Mobile ID App | AL2: One-Time-Password SMS<br>AL3: Mobile ID App (Account Recovery)<br>AL4: Mobile ID App (Account Recovery) |
 
-If your client attempts to request a scope that is not available with your current Mobile ID contract, an OIDC error `mid_sec_2020` ("unauthorized acr_values used in request", see [Error Scheme](/oidc/getting-started#error-scheme)) is returned.
+If your client attempts to request a scope that is not available with your current Mobile ID contract, an OIDC error `mid_sec_2020` ("unauthorized acr_values used in request", see [Error Scheme](/oidc-integration-guide/getting-started#error-scheme)) is returned.
 
 Please check with your commercial contact or via Backoffice.Security@swisscom.com if you are interested in ACR values that are listed in the table above but currently not configured for your Mobile ID OIDC account.
 
@@ -206,7 +206,7 @@ Location: https://client.example.org/cb?
 
 ## Access Token Request
 
-The obtained authorization code ([see here](/oidc/getting-started#authorization-code-response)) can be used to receive an access token. This chapter describes how to format the access token request and which data is returned from the access token endpoint.
+The obtained authorization code ([see here](/oidc-integration-guide/getting-started#authorization-code-response)) can be used to receive an access token. This chapter describes how to format the access token request and which data is returned from the access token endpoint.
 
 The OpenID Connect RFC states that there are 4 possible client authentication methods (used by clients to authenticate to the Authorization Server when using the Token Endpoint).
 
@@ -269,7 +269,7 @@ Authentication Method Reference (AMR) is an attribute within the OpenID Connect
 | mid_sim   | ✓        |          |          |
 | mid_sms   | ✓        |          |          |
 
-The AMR can be helpful in case the client requests an ACR with an "any" value, such as `mid_al3_any` (see section [ACR](/oidc/getting-started#authentication-context-class-reference-acr)). Since there are multiple authentication methods that comply with such ACR, the client will know from the AMR what authentication method the user actually used for the sign-in.
+The AMR can be helpful in case the client requests an ACR with an "any" value, such as `mid_al3_any` (see section [ACR](/oidc-integration-guide/getting-started#authentication-context-class-reference-acr)). Since there are multiple authentication methods that comply with such ACR, the client will know from the AMR what authentication method the user actually used for the sign-in.
 
 ### Example Access Token Response