Skip to content

Provide Microsoft.AspNetCore.Authentication.MicrosoftAccount package README #57808

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.

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
merged 1 commit into from
Sep 11, 2024
Merged
Changes from all commits
Commits
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
42 changes: 42 additions & 0 deletions src/Security/Authentication/MicrosoftAccount/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## About

`Microsoft.AspNetCore.Authentication.MicrosoftAccount` provides ASP.NET Core middleware that enables applications to support the Microsoft Account authentication workflow.

## How to Use

To use `Microsoft.AspNetCore.Authentication.MicrosoftAccount`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.Authentication.MicrosoftAccount
```

### Configuration

1. Refer to the guide in the official documentation [here](https://learn.microsoft.com/aspnet/core/security/authentication/social/microsoft-logins#create-the-app-in-microsoft-developer-portal) to create the app in Microsoft Developer Portal
2. Follow the steps in the official documentation [here](https://learn.microsoft.com/aspnet/core/security/authentication/social/microsoft-logins#store-the-microsoft-client-id-and-secret) to store the Microsoft client ID and secret
3. Add the Authentication service to your app's `Program.cs`:
```csharp
var builder = WebApplication.CreateBuilder(args);

builder.Services.AddAuthentication().AddMicrosoftAccount(microsoftOptions =>
{
microsoftOptions.ClientId = builder.Configuration["Authentication:Microsoft:ClientId"];
microsoftOptions.ClientSecret = builder.Configuration["Authentication:Microsoft:ClientSecret"];
});
```

## Main Types

The main types provided by this package are:
* `MicrosoftAccountOptions`: Represents the options for configuring Microsoft Account authentication
* `MicrosoftAccountHandler`: The authentication handler responsible for processing Microsoft Account authentication requests and generating the appropriate authentication ticket

## Additional Documentation

For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/security/authentication/social/microsoft-logins) on Microsoft Account login setup in ASP.NET Core.

## Feedback & Contributing

`Microsoft.AspNetCore.Authentication.MicrosoftAccount` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).
Loading