Ruby SDK

Added

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

Added

• Added idempotency_key parameter to the create_organization method (#173)
• Added Audit Logs module (#175)

Updated

• Uncovered private methods in Webhooks class (#171)
• Updated sorbet (#174)

Fixed

• Fixed backwards capability issue to only set write_timeout if Ruby version is greater than or equal to 2.6.0 (#169)

Added

• Added config initializer for key and timeout (#164)

Changed

• Updated endpoints for MFA operations (#167)

Added

• Added organization_id to Directory User and Directory Group, Added directory_id to Directory User (#165)

Added

• Added order pagination parameter (#156)
• Added idp_id, directory_id, created_at, updated_at, and raw_attributes to directory group (#157)
• Added primary_email method for Directory User API (#161)

Changed

• Removed environment_id fields (#155)
• Required expires_at to not be nullable for authentication challenge (#158)

Fixed

• Fixed bug where we were returning inconsistent data types from list_users and get_user endpoints (#147)

Added

• Added support for MFA API (#144)
• Added organization ID filter to list directories method (#142)
• Added full type for get_timestamp_and_signature_hash (#140)

Fixed

• Fixed bug in webhook tolerance check (#138)

Added

• Added support for domain_hint and login_hint parameters to authorization_url (#136)
• Added support for organization parameter to authorization_url (#135)

Deprecated

• Deprecated the domain parameter for authorization_url in favor of organization (#135)

Breaking Changes

• The organization_id field on the following objects is now nullable (#129):
  • Connection
  • Directory
  • Profile

Added

• Added DirectorySync.get_directory for retrieving a Directory by its ID (#132)

Fixed

• Fixed bug to make directory domain nullable (#130)

Added

• Added WorkOS::Webhooks module for verifying webhook signatures and timestamps (#113)
• Added support for allow_profiles_outside_organization for organizations (#125)
• Added organization_id to profiles (#126)

Fixed

• Fixed thread safety issues with HTTP client (#110)

Added

• Added custom_attributes for directory users (#119)
• Added created_at and updated_at attributes for connections, organizations, and directories (#120)

Added

• Added Microsoft OAuth provider enum (#116)

Changed

• Bumped addressable from 2.7.0 to 2.8.0 (#112)

Added

• Improved error handling by supporting error and error_description in the body of an error (#106)
• Supported groups attribute for a directory user object (#107)
• Added organization_id for directory object (#108)

Fixed

• Fixed regression where Authorization header accidentally had included an extra } (#104)

Added

• Added delete organization method (#102)

Added

• Added get_profile method to WorkOS::SSO (#99)

Fixed

• Fixed bug on spec.required_ruby_version to include Ruby versions 2.5+ (#100)

Breaking Changes

• SSO.profile has been renamed to SSO.profile_and_token (#96)
  • The return type has also been changed from Profile to ProfileAndToken
• Organization operations have been moved from Portal to Organizations (#95)
  • Portal.list_organizations → Organizations.list_organizations
  • Portal.get_organization → Organizations.get_organization
  • Portal.create_organization → Organizations.create_organization
  • Portal.update_organization → Organizations.update_organization
• SSO.create_connection and SSO.promote_draft_connection have been removed (#97)

Removed Deprecations

• The deprecated project_id parameter for SSO::authorization_url and SSO::profile_and_token (formerly SSO::profile) has been fully removed. The client_id parameter should be used instead (#94)

Added

• Added connection state (#89)
• Connection parameter now supported in Create Passwordless Session method (#90)
• Added update organization method (#91)
• Added get an organization by ID method (#92)

Changed

• Updated README (#88)

Deprecated

• Deprecated connection status (#89)

Added

• Exposed the idp_id for Directory Users (#87)

Updated

• Supported pagination from the WorkOS API (#82)
• Updated Ruby version to 3.0.1 (#84)

Added

• Added connection to authorization_url (#78)

Added

• Added the dsync intent for Admin Portal (#76)

Added

• Added organization id parameter to the list connections API (#74)

Added

• Supported client_id (#68)
• Added GET /connections endpoint (#70)
• Added GET /connections/:id endpoint (#72)
• Added DELETE /connections/:id endpoint (#73)

Deprecated

• Deprecated project_id (#68)

Updated

• Required JSON gem for entire WorkOS module (#65)

Fixed

• Fixed bug on Audit Trail POST /events endpoint (#64)