Installation

Command Line
cURL

Releases

v1.12.0

September 16, 2022
September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#99)

v1.11.0

September 6, 2022
September 6, 2022

Added

  • Added new supported Directory Type enumerations (#96)

v1.10.0

July 14, 2022
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)

v1.3.0

August 9, 2021
August 9, 2021

Added

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

v1.2.0

June 15, 2021
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)

v1.9.0

June 15, 2022
June 15, 2022

Added

  • Added new providers to provider list (#86)

Changed

  • Directory groups now map created_at and updated_at fields (#85)

v1.8.0

March 30, 2022
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)

v1.7.0

December 16, 2021
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)

v1.6.0

November 29, 2021
November 29, 2021

Added

  • Added webhook signature validation method (#66)
  • Added Get a Directory method (#68)

v1.5.0

September 23, 2021
September 23, 2021

Added

  • Added support for AllowProfilesOutsideOrganization to organizations (#63)
  • Added OrganizationId to profiles (#64)

v1.4.0

August 16, 2021
August 16, 2021

Added

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

v1.1.0

May 24, 2021
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)

v1.0.0

May 12, 2021
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.ListOrganizationsOrganizations.ListOrganizations
    • PortalService.CreateOrganizationOrganizations.CreateOrganization
  • SSOService.CreateConnection has been removed (#44)
  • The following fields have been removed from Connection (#39):
    • OAuthUid
    • OAuthSecret
    • OAuthRedirectUri
    • SamlEntityId
    • SamlIdpUrl
    • SamlRelyingPartyTrustCert
    • SamlX509Certs

v0.9.6

May 6, 2021
May 6, 2021

Added

  • Added Connection state replacing status (#37)

v0.9.5

May 4, 2021
May 4, 2021

Added

  • Added delete_directory endpoint(#33)

v0.9.3

March 4, 2021
March 4, 2021

Added

  • Added Dsync intent to Admin Portal (#30)

v0.9.2

February 22, 2021
February 22, 2021

Added

  • Added state to Directory Users (#27)

v0.9.1

February 2, 2021
February 2, 2021

Added

  • Added GET /connections (#21)
  • Added GET /connections/:id (#22)
  • Added DELETE /connections/:id (#23)

v0.9.0

January 7, 2021
January 7, 2021

Added

  • Return environment_id instead of project_id (#19)
  • Updated client_id values to include client_* prefix (#19)

v0.8.2

November 23, 2020
November 23, 2020

Added

  • Added support for optional redirect_uri option for creating Passwordless Sessions (#17)

v0.8.1

October 22, 2020
October 22, 2020

Changed

  • Updated ConnectionType to reflect all Connection Types currently available in GA (#15)

v0.8.0

October 14, 2020
October 14, 2020

Added

  • Added exposure to connection_id attribute on Profile objects. (#14)

v0.7.0

September 25, 2020
September 25, 2020

Added

  • Created service to connect to WorkOS Passwordless (#10)

v0.6.0

September 24, 2020
September 24, 2020

Added

  • Created service to connect to WorkOS Admin Portal (#8)

v0.3.0

September 23, 2020
September 23, 2020

Added

  • Created service to connect to WorkOS Directory Sync (#6)

v0.2.0

September 22, 2020
September 22, 2020

Added

  • Created a service to connect to WorkOS Directory Sync (#4)

v0.1.0

September 11, 2020
September 11, 2020

Added

  • Initial release of the SDK (#3)
  • Created .NET client to connect to the WorkOS API (#3)
  • Created a service to connect to WorkOS SSO (#3)