.NET SDK

Added

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

Added

• Added new supported Directory Type enumerations (#96)

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)

Added

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

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)

Added

• Added new providers to provider list (#86)

Changed

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

Added

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

Changed

• Fixed incorrect list metadata response property name (#75)

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)

Added

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

Added

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

Added

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

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)

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

Added

• Added Connection state replacing status (#37)

Added

• Added delete_directory endpoint(#33)

Added

• Added Dsync intent to Admin Portal (#30)

Added

• Added state to Directory Users (#27)

Added

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

Added

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

Added

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

Changed

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

Added

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

Added

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

Added

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

Added

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

Added

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

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)