WorkOS.net 0.3.0

workos-dotnet

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