Skip to content

V3 upgrade guide- MSAL related updates #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikithauc merged 2 commits into from
Jul 28, 2021
Merged

V3 upgrade guide- MSAL related updates #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02dcfcf
3.0.0-preview-3 release
nikithauc Jul 28, 2021
6929430
msal updates
nikithauc Jul 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions changelogs/v3-upgrade-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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.
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@microsoft/microsoft-graph-client",
"version": "3.0.0-Preview.2",
"version": "3.0.0-Preview.3",
"description": "Microsoft Graph Client Library",
"keywords": [
"Microsoft",
Expand Down
2 changes: 1 addition & 1 deletion src/Version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@
* @module Version
*/

export const PACKAGE_VERSION = "3.0.0-Preview.2";
export const PACKAGE_VERSION = "3.0.0-Preview.3";