Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/okta/okta-aspnet

okta-aspnet
https://github.com/okta/okta-aspnet

Last synced: 2 days ago
JSON representation

okta-aspnet

Awesome Lists containing this project

README 

        
[](https://devforum.okta.com/)



[![Support](https://img.shields.io/badge/support-Developer%20Forum-blue.svg)](https://devforum.okta.com/)



# Okta ASP.NET middleware



- [Okta ASP.NET middleware](#okta-aspnet-middleware)

- [Release status](#release-status)

- [Need help?](#need-help)

- [What you need](#what-you-need)

- [Getting Started](#getting-started)

- [Contributing](#contributing)



This package will enable your ASP.NET application to work with Okta via OAuth 2.0/OIDC. You can follow our instructions below, check out our examples on GitHub or [jump to our guides](https://developer.okta.com/docs/guides/sign-into-web-app-redirect/asp-net-core-3/main/) to see how to configure Okta with your ASP.NET applications.



We also publish these other libraries for .NET:



- [Okta .NET Management SDK](https://github.com/okta/okta-sdk-dotnet)

- [Okta .NET Authentication SDK](https://github.com/okta/okta-auth-dotnet)



## Release status



This library uses semantic versioning and follows Okta's [library version policy](https://developer.okta.com/code/library-versions/).



:heavy_check_mark: The current stable major version series is: 4.x for Okta.AspNetCore and 2.x for Okta.AspNet.



|Package| Version | Status                    | Compatibility|

| ------- | ------- | ------------------------- | ----------------------- |

|`Okta.AspNet.Abstractions`| 5.x   | :heavy_check_mark: Stable | .NET Standard 2.0 and .NET Framework 4.6.2 or higher.|

|`Okta.AspNet.Abstractions`| 4.x   | :warning: Retiring November 28th, 2023 | .NET Standard 2.0 and .NET Framework 4.5.2 or higher.|

|`Okta.AspNet`| 3.x | :heavy_check_mark: Stable | .NET Framework 4.6.2 |

|`Okta.AspNet`| 2.x | :warning: Retiring | .NET Framework 4.5.2 |

|`Okta.AspNetCore`| 4.x | :heavy_check_mark: Stable | .NET Core 3.x, .NET 5.0, .NET 6.0, .NET 7.0 and .NET 8.0 |

|`Okta.AspNetCore`| 3.x | :warning: Retiring | .NET Standard 2.0 and .NET Core 2.x |



The latest release can always be found on the [releases page][github-releases].



## Need help?



If you run into problems using the SDK, you can



- Ask questions on the [Okta Developer Forums][devforum] or email [email protected].

- Post [issues][github-issues] here on GitHub (for code errors)



## What you need



An Okta account (sign up for a [forever-free developer account](https://developer.okta.com/signup/))



## Getting Started



If you want to build an ASP.NET MVC application we highly recommend you to check out [this guide](https://developer.okta.com/docs/guides/sign-into-web-app-redirect/asp-net-core-3/main/) to see what you need to get started and how sign users in your web application using the Okta ASP.NET SDK. You can also check out the following resources:



- [Getting started with ASP.NET MVC](https://github.com/okta/okta-aspnet/blob/master/docs/aspnet4x-mvc.md)

- [Getting started with ASP.NET Core MVC](https://github.com/okta/okta-aspnet/blob/master/docs/aspnetcore-mvc.md)



Also, if you want to build an ASP.NET Web API application check out [this guide](https://developer.okta.com/docs/guides/protect-your-api/aspnetcore3/main/) to see how to protect your endpoints using the Okta ASP.NET SDK. You can also check out the following resources:



- [Getting started with ASP.NET Web API](https://github.com/okta/okta-aspnet/blob/master/docs/aspnet4x-webapi.md)

- [Getting started with ASP.NET Core Web API](https://github.com/okta/okta-aspnet/blob/master/docs/aspnetcore-webapi.md)

- [Refreshing Access Token in ASP.NET MVC or WebForms App](https://github.com/okta/okta-aspnet/tree/master/docs/refresh-token.md)

- [Refreshing Access Token in ASP.NET Core Applications](https://github.com/okta/okta-aspnet/tree/master/docs/refresh-token-aspnetcore.md)



To learn more about this library you can explore the following additional resources:



- [Guides](https://developer.okta.com/docs/guides/)

- [ASP.NET 4.x samples](https://github.com/okta/samples-aspnet)

- [ASP.NET Web Forms samples](https://github.com/okta/samples-aspnet-webforms/)

- [ASP.NET Core samples](https://github.com/okta/samples-aspnetcore)

- [Project Documentation](https://github.com/okta/okta-aspnet/tree/master/docs)



## Contributing



Issues and Pull Requests are welcome! To build the project, clone and build it with Visual Studio 2017 or newer.



Be aware that these assemblies are strong-named:



- Okta.AspNet

- Okta.AspNet.Abstractions

- Okta.AspNet.Test



In order to be able to debug those assemblies locally you can either remove strong-naming by unchecking "Sign the assembly" check box in the project options or temporarily add them to ignore list using the Strong Name Tool:



```bash

sn.exe -Vr (path-to)\Okta.AspNet.dll

sn.exe -Vr (path-to)\Okta.AspNet.Abstractions.dll

sn.exe -Vr (path-to)\Okta.AspNet.Test.dll

```



You should restart Visual Studio after making these changes.



Check out the [Contributing Guide](https://github.com/okta/okta-aspnet/tree/master/CONTRIBUTING.md).



[github-issues]: https://github.com/okta/okta-aspnet/issues

[github-releases]: https://github.com/okta/okta-aspnet/releases

[devforum]: https://devforum.okta.com/