WorkOS.net 0.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package WorkOS.net --version 0.2.0
NuGet\Install-Package WorkOS.net -Version 0.2.0
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="WorkOS.net" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add WorkOS.net --version 0.2.0
#r "nuget: WorkOS.net, 0.2.0"
#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.
// Install WorkOS.net as a Cake Addin
#addin nuget:?package=WorkOS.net&version=0.2.0

// Install WorkOS.net as a Cake Tool
#tool nuget:?package=WorkOS.net&version=0.2.0

workos-dotnet

Build Status NuGet version (WorkOS.net)

The official WorkOS .NET SDK supporting .NET Standard 2.0+ and .NET Framework 4.6.1+.

Documentation

Complete documentation for the library can be found here.

Installation

There are several options to install the WorkOS .NET SDK.

Via the NuGet Package Manager

nuget install WorkOS.net

Via the .NET Core Command Line Tools

dotnet add package WorkOS.net

Via Visual Studio IDE

Install-Package WorkOS.net

Configuration

To use the WorkOS client, you must provide an API key from the WorkOS dashboard.

WorkOS.SetApiKey("sk_key123");

You can also optionally provide a custom HttpClient.

var client = new WorkOSClient(
    new WorkOSOptions
    {
        ApiKey = "sk_key123",
        HttpClient = ...,
    });
WorkOS.WorkOSClient = client;

Example Usage

The example below demonstrates exchanging an authorization code for a WorkOS Profile.

var ssoService = new SSOService();
var options = new GetProfileOptions
{
    ClientId = "project_123",
    Code = "code_123",
};
var response = ssoService.GetProfile(options);

When applicable, calls can be made asynchronously and return a Task.

var response = await ssoService.GetProfileAsync(options);

Development and Testing

Run all tests with the following command:

dotnet test test/WorkOSTests/WorkOSTests.csproj

Run tests for a specific framework with the following command:

dotnet test test/WorkOSTests/WorkOSTests.csproj -f netcoreapp3.1
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
2.0.0 2,421 12/14/2023
1.17.4 8,085 5/25/2023
1.17.3 1,060 3/29/2023
1.17.2 207 3/27/2023
1.17.0 1,715 3/7/2023
1.16.0 9,343 12/6/2022
1.15.2 751 12/5/2022
1.15.1 291 12/2/2022
1.15.0 3,695 11/9/2022
1.14.0 407 10/18/2022
1.13.0 1,091 10/12/2022
1.12.0 421 9/16/2022
1.11.0 389 9/6/2022
1.10.0 1,820 7/14/2022
1.9.0 411 7/14/2022
1.8.0 10,547 3/30/2022
1.8.0-alpha.3 121 3/15/2022
1.8.0-alpha.2 115 2/22/2022
1.8.0-alpha.1 112 2/22/2022
1.7.0 788 12/16/2021
1.6.0 1,002 11/29/2021
1.5.0 9,889 9/23/2021
1.4.0 518 8/16/2021
1.3.0 318 8/9/2021
1.2.0 404 6/15/2021
1.1.0 539 5/24/2021
1.0.0 303 5/12/2021
0.9.6 367 5/6/2021
0.9.5 284 5/4/2021
0.9.4 317 4/8/2021
0.9.3 349 3/4/2021
0.9.2 310 2/22/2021
0.9.1 338 2/2/2021
0.9.0 381 1/7/2021
0.8.2 377 11/30/2020
0.8.1 403 10/22/2020
0.8.0 432 10/14/2020
0.7.0 392 9/25/2020
0.6.0 425 9/24/2020
0.3.0 460 9/23/2020
0.2.0 520 9/22/2020
0.1.0 421 9/11/2020