Skip to content

Commit c60c0e9

Browse files
author
Swasti Gupta
committed
Fix some .md errors
1 parent 5960345 commit c60c0e9

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

docs/MSAL_2x_Release_Announcement_and_Migration_Guide.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ This standardization enables secure and valid redirection to brokered authentica
2626

2727
#### How to Migrate
2828

29-
#####a. Register a valid redirect URI
29+
##### 1. Register a valid redirect URI
3030

3131
In the Azure Portal under-App Registrations > Authentication, configure a redirect URI in the format: `msauth.[BUNDLE_ID]://auth`.
3232

3333
Note: If migrating from ADAL, the `<scheme>://[BUNDLE_ID]` format is still supported.
3434

3535
⚠️ Important: Ensure this redirect URI is configured across all app targets and extensions (such as Share Extensions) to enable smooth brokered authentication.
3636

37-
#####b. Update Info.plist
37+
##### 2. Update Info.plist
3838

3939
Add the following entry to your app’s Info.plist:
4040

@@ -50,7 +50,7 @@ Add the following entry to your app’s Info.plist:
5050
</array>
5151
```
5252

53-
#####c. Add URL schemes to Info.plist
53+
##### 3. Add URL schemes to Info.plist
5454

5555
Include the following in Info.plist under LSApplicationQueriesSchemes:
5656

@@ -62,7 +62,7 @@ Include the following in Info.plist under LSApplicationQueriesSchemes:
6262
</array>
6363
```
6464

65-
#####d. Initialize MSALPublicClientApplication using the configured redirect URI
65+
##### 4. Initialize MSALPublicClientApplication using the configured redirect URI
6666

6767
Objective-C:
6868
```objc
@@ -103,7 +103,7 @@ Note: Remember to replace any placeholder values with your actual app-specific v
103103

104104
⚠️ Important: Do not set bypassRedirectURIValidation = YES/true on MSALPublicClientApplicationConfig when using enterprise (AAD) redirect URIs. This will disable MSAL’s validation and brokered authentication, leading to failures in supported authentication scenarios.
105105

106-
### Invalid Format Handling
106+
#### Invalid Format Handling
107107

108108
If an invalid redirect URI is provided for enterprise (AAD) scenarios, MSAL will fail at initialization of `MSALPublicClientApplication` with the following error:
109109

@@ -114,7 +114,7 @@ If an invalid redirect URI is provided for enterprise (AAD) scenarios, MSAL will
114114
| **Internal Error Code** | `-42011` |
115115
| **Description** | Varies depending on the validation failure (e.g., missing scheme, mismatched bundle ID, invalid host) |
116116

117-
### Common Redirect URI Errors
117+
#### Common Redirect URI Errors
118118

119119
| Error Scenario | Example | Error Description |
120120
|------------------------------|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -141,7 +141,7 @@ This ensures that the authentication UI can be correctly presented over the app'
141141

142142
#### How to Migrate
143143

144-
##### a. Initialize MSALPublicClientApplication using the configured redirect URI
144+
##### 1. Initialize MSALPublicClientApplication using the configured redirect URI
145145

146146
Objective-C:
147147
```objc
@@ -156,7 +156,7 @@ let viewController = ... // Your UI ViewController
156156
let webviewParameters = MSALWebviewParameters(authPresentationViewController: viewController)
157157
```
158158

159-
##### b. Pass it to `MSALInteractiveTokenParameters`
159+
##### 2. Pass it to `MSALInteractiveTokenParameters`
160160

161161
Objective-C:
162162
```objc
@@ -212,11 +212,11 @@ This change **consolidates all account-related properties** into a single protoc
212212

213213
#### How to Migrate
214214

215-
##### a. Header Import Updates
215+
##### 1. Header Import Updates
216216

217217
Remove any direct imports of MSALAccount+MultiTenantAccount.h. Instead, always import the umbrella header: MSAL.h
218218

219-
##### b. Swift Property Access Updates
219+
##### 2. Swift Property Access Updates
220220

221221
If you access the following properties in Swift:
222222

@@ -253,7 +253,7 @@ This removes reliance on outdated methods, streamlines code maintenance, and ens
253253

254254
#### How to Migrate
255255

256-
#### 1. MSALPublicClientApplication Initializers
256+
##### 1. MSALPublicClientApplication Initializers
257257

258258
**Deprecated:**
259259
- `initWithClientId:authority:error:`
@@ -289,7 +289,7 @@ config.knownAuthorities = [authority]
289289
let application = try! MSALPublicClientApplication(configuration: config)
290290
```
291291

292-
#### 2. Token Acquisition (Silent)
292+
##### 2. Token Acquisition (Silent)
293293

294294
**Deprecated:**
295295
- `acquireTokenSilentForScopes:account:authority:`
@@ -327,7 +327,7 @@ application.acquireTokenSilent(with: parameters) { (result, error) in
327327
}
328328
```
329329

330-
#### 3. Token Acquisition (Interactive)
330+
##### 3. Token Acquisition (Interactive)
331331

332332
**Deprecated:**
333333
- `acquireTokenForScopes:`
@@ -364,7 +364,7 @@ application.acquireToken(with: parameters) { (result, error) in
364364
}
365365
```
366366

367-
#### 4. Account Management APIs
367+
##### 4. Account Management APIs
368368

369369
**Deprecated:**
370370
- `accountForHomeAccountId:error:`
@@ -423,7 +423,7 @@ application.allAccountsFilteredByAuthority { (accounts, error) in
423423
}
424424
```
425425

426-
### MSALLogger is Deprecated – Use MSALLoggerConfig Instead
426+
##### 5. MSALLogger is Deprecated – Use MSALLoggerConfig Instead
427427

428428
MSALLogger’s singleton-based logging approach is now deprecated. Configure logging behavior via MSALGlobalConfig.loggerConfig.
429429

@@ -471,15 +471,15 @@ MSALGlobalConfig.loggerConfig.setLogCallback { (level, message, containsPII) in
471471
}
472472
```
473473

474-
### Summary: MSALLogger Deprecations
474+
###### Summary: MSALLogger Deprecations
475475

476476
| Deprecated Item | Replacement |
477477
|-------------------------------|--------------------------------------|
478478
| MSALLogger.sharedLogger | MSALGlobalConfig.loggerConfig |
479479
| MSALLogger.level | MSALGlobalConfig.loggerConfig.logLevel |
480480
| setCallback: | setLogCallback: via loggerConfig |
481481

482-
### MSALTelemetry is Deprecated – Use MSALTelemetryConfig Instead
482+
##### 6. MSALTelemetry is Deprecated – Use MSALTelemetryConfig Instead
483483

484484
MSALTelemetry’s singleton is deprecated. Configure telemetry via MSALGlobalConfig.telemetryConfig.
485485

@@ -530,7 +530,7 @@ MSALGlobalConfig.telemetryConfig.telemetryCallback = { event in
530530
}
531531
```
532532

533-
### Summary: MSALTelemetry Deprecations
533+
###### Summary: MSALTelemetry Deprecations
534534

535535
| Deprecated Item | Replacement |
536536
|-------------------------------|--------------------------------------|

0 commit comments

Comments
 (0)