craigsmitham / workos-dotnet

Official .NET SDK for interacting with the WorkOS API

WorkOS .NET Library

The WorkOS library for .NET provides convenient access to the WorkOS API from applications using .NET. Supports .NET Standard 2.0+ and .NET Framework 4.6.1+

Documentation

See the API Reference for .NET usage examples.

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;

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

More Information

• Single Sign-On Guide
• Directory Sync Guide
• Admin Portal Guide
• Magic Link Guide