Skip to content

Commit

Permalink
V3 upgrade guide- MSAL related updates (#489)
Browse files Browse the repository at this point in the history
* 3.0.0-preview-3 release

* msal updates
  • Loading branch information
nikithauc committed Jul 28, 2021
1 parent 0ca5b49 commit b34b899
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions changelogs/v3-upgrade-guide.md
Expand Up @@ -11,6 +11,12 @@
- Microsoft Graph JS SDK requires Node.js 12 LTS or higher. The active Long Term Service (LTS) version of Node.js is used for on-going testing of existing and upcoming product features.
- Updated to TypeScript 4.x.

### Removing `ImplicitMSALAuthenticationProvider` and `MSALAuthenticationProviderOptions` class.

- Use of `ImplicitMSALAuthenticationProvider`, that is,using the implicit authorization flow is not recommended any more. [OAuth 2.0 Implicit Grant](https://oauth.net/2/grant-types/implicit/).
- The 3.0.0 version introduces `AuthCodeMSALBrowserAuthenticationProvider` which supports the [MSAL Browser](https://www.npmjs.com/package/@azure/msal-browser) and enables authorization using the Authentication Code Flow with PKCE. Learn more about the [AuthCodeMSALBrowserAuthenticationProvider](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/AuthCodeMSALBrowserAuthenticationProvider.md).
- Alternatively, you can implement a `CustomAuthenticationProvider` with an auth library of your choice. Learn more using the [samples](https://github.com/microsoftgraph/msgraph-sdk-javascript#samples-and-tutorials).

### LargeFileUploadTask

- Modified the `FileObject` interface which now contains the `sliceFile` function. Learn more [LargeFileUploadTask](../docs/tasks/LargeFileUploadTask.md).
Expand Down Expand Up @@ -47,11 +53,15 @@

## Enhancements

### Introducing support for `@azure/msal-browser`
- The 3.0.0 version introduces `AuthCodeMSALBrowserAuthenticationProvider` which supports authentication using the [MSAL Browser](https://www.npmjs.com/package/@azure/msal-browser)
- `AuthCodeMSALBrowserAuthenticationProvider` enables authorization using the Authentication Code Flow with PKCE. Learn more about the [AuthCodeMSALBrowserAuthenticationProvider](https://github.com/microsoftgraph/msgraph-sdk-javascript/blob/dev/docs/AuthCodeMSALBrowserAuthenticationProvider.md).

### Introducing support for `@azure/identity TokenCredentials`

- Added a `TokenCredentialAuthenticationProvider` enabling the use of `@azure/identity` `credential classes` for authentication purposes.
- The `TokenCredentialAuthenticationProvider` enables server-side authentication using `credential classes` such as `ClientSecretCredential` or `ClientCertificateCredential`.
- Find the samples on how to use `TokenCredentialAuthenticationProvider` here - [TokenCredentialAuthenticationProvider samples](../samples/tokenCredentialSamples)
- Find the samples on how to use `TokenCredentialAuthenticationProvider` here - [TokenCredentialAuthenticationProvider samples](../samples/javascript/clientInitialization/tokenCredentialAuthenticationProvider)

### LargeFileUploadTask

Expand Down Expand Up @@ -81,11 +91,6 @@ const client = Client.initWithMiddleware({ middleware, customHosts });

## Deprecation

### Deprecating `ImplicitMSALAuthenticationProvider`

- Use of `ImplicitMSALAuthenticationProvider`, that is,using the implicit authorization flow is not recommended any more. [OAuth 2.0 Implicit Grant](https://oauth.net/2/grant-types/implicit/).
- Alternatively, you can implement a `CustomAuthenticationProvider` with an auth library of your choice. Learn more using the [samples](https://github.com/microsoftgraph/msgraph-sdk-javascript#samples-and-tutorials).

### Deprecating the `sliceFile` function of the `LargeFileUploadTask` class.

- The `sliceFile` function has been moved to the `FileObject` interface.

0 comments on commit b34b899

Please sign in to comment.