Add and configure packages

First, install an Okta SDK for your framework to help validate incoming tokens.

Include the dependency

Instructions for

ASP.NET Core 3.x

Loading...

All of our .NET SDKs are hosted on NuGet (opens new window). Install the Okta.AspNetCore (opens new window) 3.x series dependency in your project via the NuGet Package Manager:

1. In the Solution Explorer, right-click your solution and select Manage Nuget Packages for Solution.
2. Click Browse and search for the package you want to install, for example, Okta.AspNetCore.
3. Select your package and click Install.

You can also install the dependency via the dotnet CLI:

dotnet add package Okta.AspNetCore

Configure the middleware

You need to configure the Okta SDK with some information about your Okta domain. You can provide this configuration through environment variables, configuration files, or in code. Then, put the middleware provided by the SDK into your application's pipeline.

Things you need

• Okta Domain — The Okta Domain can be found on the Admin Console's global header in the upper-right corner of the page. Click the section that displays your email and company name. A drop-down menu appears and displays general org information including the full Okta domain (for example, subdomain.okta.com).

• Audience — The audience of your Authorization Server (opens new window). The default value is api://default.

Note: https://${yourOktaDomain} is different from your admin URL. Don't include -admin in the value.

Instructions for

ASP.NET Core 3.x

Loading...

Open your Startup class and modify the ConfigureServices method to include the Okta middleware configuration. Replace the placeholders with your Okta configuration:

public void ConfigureServices(IServiceCollection services)
{
    services.AddAuthentication(options =>
    {
        options.DefaultAuthenticateScheme = OktaDefaults.ApiAuthenticationScheme;
        options.DefaultChallengeScheme = OktaDefaults.ApiAuthenticationScheme;
        options.DefaultSignInScheme = OktaDefaults.ApiAuthenticationScheme;
    })
    .AddOktaWebApi(new OktaWebApiOptions()
    {
        OktaDomain = Configuration["Okta:OktaDomain"],
    });

    services.AddAuthorization();
    
    services.AddControllers();
}

Modify the Configure method to have the app.UseAuthentication() and app.UseAuthorization() lines:

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    //...
    app.UseRouting();

    app.UseAuthentication();

    app.UseAuthorization();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

Update your using statements to import Okta.AspNetCore:

using Okta.AspNetCore;

The OktaWebApiOptions class configures the Okta middleware. You can see all of the available options in the Configuration Reference section in the Okta ASP.NET Core GitHub (opens new window) repo.

Next: Require authentication