BizDoc.Core.Okta 6.8.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
Suggested Alternatives

BizDoc.Authentication.Okta

dotnet add package BizDoc.Core.Okta --version 6.8.1
                    


                    

                
NuGet\Install-Package BizDoc.Core.Okta -Version 6.8.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="BizDoc.Core.Okta" Version="6.8.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BizDoc.Core.Okta" Version="6.8.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BizDoc.Core.Okta" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add BizDoc.Core.Okta --version 6.8.1
                    


                    

                
#r "nuget: BizDoc.Core.Okta, 6.8.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package BizDoc.Core.Okta@6.8.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=BizDoc.Core.Okta&version=6.8.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BizDoc.Core.Okta&version=6.8.1
                    


                            Install as a Cake Tool

Okta for BizDoc

BizDoc supports Okta for both authentication and authorization, in one of two configurations: server flow or client flow.

Server flow redirects unauthorized users to Okta sign-in page on Okta domain, and handles the redirect. Client flow prompts unauthorized users for credentials in an hosted widget, and negotiate with Okta on the background.

  1. For both modes, install BizDoc Nuget package:
dotnet add package BizDoc.Core.Okta
  1. Add Okta application. If using server mode, choose Web Application. If using client mode, choose ODIC - OpenID Connect, and select SPA.

Okta sign-in redirect url should match "/authorization-code/callback" on server mode, and no path for client mode.

Create an API Token to allow BizDoc to retrieve users information.

  1. In startup.cs, add Okta service.

For server flow, use AddOktaRedirect:

AddBizDoc(o=> {
    o.ApplicationUri = "https://app-domain/";
  })
  .AddOktaServer(o=> {
    o.ApiToken = "api-token";
    o.Domain = "domain-name";
    o.ClientId = "client-id";
    o.ClientSecret = "client-secret";
  });
  ...
UseBizDoc().
  .UseOktaServer();

For client mode, use AddOkta:

AddBizDoc(...)
  .AddOkta(o=> {
    o.ApiToken = "api-token";
    o.Domain = "domain-name";
  }).
    UseIdentityProvider();

The UseIdentityProvider() method registers an identity provider which retrieve user information from Okta. To use a different provider, while still authenticating via Okta, see Implementing Identity Provider.

  1. Client mode only, install Angular package:
npm i @bizdoc/okta

Add Okta configuration in Angular app.module:

OktaModule.forRoot({
  domain: 'domain-name',
  clientId: 'client-id'  
})

Roles

In order to map user groups to BizDoc roles for authorization purposes, add a new claim to Okta Authorization Server with the following specifications.

Property Value
Name bizdoc.roles
Include in token type ID Token
Value type Groups
Filter Matches regex, .*
Include in Any scope
System

Add an attribute to either application profile or all profiles and set its type to boolean. Add a claim in API server that map to the profile attribute you created.

Property Value
Name bizdoc.admin
Include in token type ID Token
Value type Expression
Value user.{attr-name-here}

Resolvers

Name Usage
CostCenterResolver
DepartmentResolver
DivisionResolver
OrganizationResolver
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
6.8.1 795 10/18/2022 6.8.1 is deprecated because it is no longer maintained.
6.8.0 612 10/16/2022
6.7.3 573 8/8/2022
6.7.2 572 7/21/2022
6.7.1 596 7/12/2022
6.6.5 615 7/3/2022
6.6.4 589 6/26/2022
6.6.3 570 6/26/2022
6.6.2 577 6/15/2022
6.6.1 580 5/28/2022
6.6.0 575 5/20/2022
6.5.3 610 4/27/2022
6.5.2 593 4/13/2022
6.5.1 571 4/6/2022
6.5.0 630 4/5/2022
6.4.0 618 3/8/2022
6.3.5 620 2/16/2022
6.3.4 646 2/10/2022
6.3.3 608 2/7/2022
6.3.2 643 2/2/2022
Loading failed