WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

.NET SDK

github.com
workos/workos-dotnet
12 Stars
8 Forks
20 Contributors
github.com
Official .NET SDK for interacting with the WorkOS API.

Installation

Command Line
.NET

Beta Versions

Certain WorkOS features may be available only in the beta version of the SDK. Beta versions have the -beta.* suffix, for example, 3.2.0-beta.1. For more information on how to use the beta versions, refer to the README in the GitHub repository.

Releases

October 21, 2024

v2.5.0

Latest
October 21, 2024

What's Changed

  • Add role to profile by @kendallstrautman in https://github.com/workos/workos-dotnet/pull/179

Full Changelog: https://github.com/workos/workos-dotnet/compare/v2.4.0...v2.5.0

September 23, 2024

v2.4.0

September 23, 2024

What's Changed

  • Added custom exceptions for webhook verification by @gcsuk in https://github.com/workos/workos-dotnet/pull/177

New Contributors

  • @gcsuk made their first contribution in https://github.com/workos/workos-dotnet/pull/177

Full Changelog: https://github.com/workos/workos-dotnet/compare/v2.3.0...v2.4.0

July 18, 2024

v2.3.0

July 18, 2024

What's Changed

  • Add AppleOAuth constants by @gcarvelli in https://github.com/workos/workos-dotnet/pull/167
  • Fix CI badge + add NuGet one by @gcarvelli in https://github.com/workos/workos-dotnet/pull/172
  • v2.3.0 by @gcarvelli in https://github.com/workos/workos-dotnet/pull/170
  • Added missing values to DirectoryState enum by @WillyPain in https://github.com/workos/workos-dotnet/pull/174

New Contributors

  • @gcarvelli made their first contribution in https://github.com/workos/workos-dotnet/pull/167
  • @WillyPain made their first contribution in https://github.com/workos/workos-dotnet/pull/174

Full Changelog: https://github.com/workos/workos-dotnet/compare/v2.2.0...v2.3.0

June 26, 2024

v2.2.0

June 26, 2024

Deprecated

  • Marked the AllowProfilesOutsideOrganization option as deprecated (#168)
May 8, 2024

v2.1.0

May 8, 2024

What's Changed

  • Add DomainData to Organization create and update methods, replacing deprecated domains (#165)
December 14, 2023

v2.0.0

December 14, 2023

Added

  • Added ActorIds and ActorNames to CreateAuditLogExportOptions #127

Changed

  • [Breaking change] Renamed User to DirectoryUser (#132)
  • [Breaking change] Renamed ConnectionType to Type (#138)
  • [Breaking change] Changed directory states from linked/unlinked to active/inactive (#142)
  • [Breaking change] Changed default list pagination order to be DESC (#159)
  • [Breaking change] Changed Connection.Type to be a string and add ProviderType (#154)

Removed

  • [Breaking change] Removed Connection Status (#137)

Full Changelog: https://github.com/workos/workos-dotnet/compare/v1.17.4...v2.0.0

May 25, 2023

v1.17.4

May 25, 2023

Changed

  • Added CreatedAtand UpdatedAt to directory user (#129)
  • Added validating enum to ConnectionState (#128)
March 29, 2023

v1.17.3

March 29, 2023

What's Changed

  • Fix user enums to include "Inactive"
March 27, 2023

v1.17.2

March 27, 2023

Changed

  • Added missing types int and long to FlattenQueryParameters (#119 )
  • ListOrganizationOptions now inherits ListOptions (#121 )
March 7, 2023

v1.17.0

March 7, 2023

Added

  • Added groups attribute to SSO user profile. This feature is in beta, please reach out to support@workos.com to access this feature. (#117)
December 6, 2022

v1.16.0

December 6, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-dotnet/pull/114)
December 2, 2022

v1.15.2

December 2, 2022

Changed

  • Added missing properties user and issuer to totp entity (#111 )
December 2, 2022

v1.15.1

December 2, 2022

Changed

  • DeleteConnection now returns a Task (#110 )
November 9, 2022

v1.15.0

November 9, 2022

Added

  • Add idempotencyKey to CreateOrganization(#102)
  • Add CreateAuditLogEventOptions options to CreateEvent in audit logs(#107)
October 18, 2022

v1.14.0

October 18, 2022

Added

  • Added SuccessURL to GenerateLinkOptions(#105)
October 12, 2022

v1.13.0

October 12, 2022

Added

  • Added PrimaryEmail getter method to directory users (#101)
  • Added job title attribute for directory users (#103)
September 16, 2022

v1.12.0

September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#99)
September 6, 2022

v1.11.0

September 6, 2022

Added

  • Added new supported Directory Type enumerations (#96)
July 14, 2022

v1.10.0

July 14, 2022

Added

  • Added DirectoryId and OrganizationId to DirectoryUsers and DirectoryGroups (#92)

Changed

  • Updated endpoints used for MFA operations (#89)

Deprecated

  • The VerifyFactor attribute has been deprecated in favor of VerifyChallenge (#89)
August 9, 2021

v1.3.0

August 9, 2021

Added

  • Exposed custom_attributes for directory users (#57)
  • Added Auth0SAML as a supported ConnectionType (#58)
June 15, 2021

v1.2.0

June 15, 2021

Added

  • Uncovered groups in Get Directory User Method (#52)
  • Exposed expires_in parameter when creating passwordless sessions (#53)
  • Added OrganizationId to Directory endpoint (#53)

Changed

  • Fixed URL to point to GitHub page (#55)
June 15, 2022

v1.9.0

June 15, 2022

Added

  • Added new providers to provider list (#86)

Changed

  • Directory groups now map created_at and updated_at fields (#85)
March 30, 2022

v1.8.0

March 30, 2022

Added

  • Added MFA API support (#79)
  • Added Organization filter to list directories method (#80)

Changed

  • Fixed incorrect list metadata response property name (#75)
December 16, 2021

v1.7.0

December 16, 2021

Added

  • Added support for domain_hint and login_hint parameters to GetAuthorizationURL (#72)
  • Added support for organization parameter to GetAuthorizationURL (#71)

Changed

  • Deprecated domain parameter for GetAuthorizationURL in favor of organization (#71)
November 29, 2021

v1.6.0

November 29, 2021

Added

  • Added webhook signature validation method (#66)
  • Added Get a Directory method (#68)
September 23, 2021

v1.5.0

September 23, 2021

Added

  • Added support for AllowProfilesOutsideOrganization to organizations (#63)
  • Added OrganizationId to profiles (#64)
August 16, 2021

v1.4.0

August 16, 2021

Added

  • Added created_at and updated_at fields (#61)
  • Added connection types for CyberArk, GoogleSAML, SalesForce and JumpCloud (#60)
May 24, 2021

v1.1.0

May 24, 2021

Added

  • Added SSOService.GetProfile (#47)
  • Added OrganizationsService.DeleteOrganization (#48 & #49)

Changed

  • Fixed an issue with DirectoriesService.DeleteDirectory where an error would be thrown when trying to decode the API response (#50)
May 12, 2021

v1.0.0

May 12, 2021

Breaking Changes

Synchronous API Removal

All synchronous methods for performing WorkOS API calls have been removed in (#41). These calls block the application thread, which results in poor performance and can even lead to deadlock.

The asynchronous methods (previously suffixed with Async) have been renamed to take the place of the synchronous methods. For example, GetProfileAndTokenAsync is now GetProfileAndToken.

If you were previously using the asynchronous methods you will need to drop the Async suffix.

If you were previously using the synchronous methods it is highly recommended you migrate your code to use async/await. If this is not possible for some reason, you can use the Task<T>.Result property to synchronously await the result. Accessing this property will block the calling thread until the API request completes.

Added

  • Added Connection property to CreatePasswordlessSessionOptions (#38)
    • This can be used to create a Passwordless Session for a particular Connection rather than using the domain from the email to determine the Organization and Connection.
  • Added OrganizationsService.GetOrganization (#45)
  • Added OrganizationsService.UpdateOrganization (#40)
  • Exposed OrganizationId on Connections (#39)

Changed

  • SSOService.GetProfile has been renamed to SSOService.GetProfileAndToken (#43)
    • The return type has also been changed from Task<Profile> to Task<ProfileAndToken>
  • Organization operations have been moved from the PortalService class to OrganizationsService (#42)
    • PortalService.ListOrganizations → Organizations.ListOrganizations
    • PortalService.CreateOrganization → Organizations.CreateOrganization
  • SSOService.CreateConnection has been removed (#44)
  • The following fields have been removed from Connection (#39):
    • OAuthUid
    • OAuthSecret
    • OAuthRedirectUri
    • SamlEntityId
    • SamlIdpUrl
    • SamlRelyingPartyTrustCert
    • SamlX509Certs
May 6, 2021

v0.9.6

May 6, 2021

Added

  • Added Connection state replacing status (#37)