Installation

Command Line
cURL

Releases

v2.7.0

September 16, 2022
September 16, 2022

Added

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

v2.6.0

September 15, 2022
September 15, 2022

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)

v2.5.1

August 12, 2022
August 12, 2022

Fixed

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

v2.5.0

July 25, 2022
July 25, 2022

Added

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

Changed

  • Updated endpoints for MFA operations (#167)

v2.4.0

July 14, 2022
July 14, 2022

Added

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

v2.3.0

June 13, 2022
June 13, 2022

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)

v2.2.1

April 28, 2022
April 28, 2022

Fixed

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

v2.2.0

March 30, 2022
March 30, 2022

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)

v2.1.1

January 14, 2022
January 14, 2022

Fixed

  • Fixed bug in webhook tolerance check (#138)

v2.1.0

December 16, 2021
December 16, 2021

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)

v2.0.0

November 12, 2021
November 12, 2021

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)

v1.6.1

November 3, 2021
November 3, 2021

Fixed

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

v1.6.0

September 23, 2021
September 23, 2021

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)

v1.5.1

September 1, 2021
September 1, 2021

Fixed

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

v1.5.0

August 13, 2021
August 13, 2021

Added

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

v1.4.0

July 29, 2021
July 29, 2021

Added

  • Added Microsoft OAuth provider enum (#116)

Changed

  • Bumped addressable from 2.7.0 to 2.8.0 (#112)

v1.3.0

June 8, 2021
June 8, 2021

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)

v1.2.1

June 1, 2021
June 1, 2021

Fixed

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

v1.2.0

May 25, 2021
May 25, 2021

Added

  • Added delete organization method (#102)

v1.1.0

May 24, 2021
May 24, 2021

Added

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

Fixed

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

v1.0.0

May 12, 2021
May 12, 2021

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_organizationsOrganizations.list_organizations
    • Portal.get_organizationOrganizations.get_organization
    • Portal.create_organizationOrganizations.create_organization
    • Portal.update_organizationOrganizations.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)

v0.11.2

May 10, 2021
May 10, 2021

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)

v0.11.1

April 29, 2021
April 29, 2021

Added

  • Exposed the idp_id for Directory Users (#87)

v0.11.0

August 5, 2022
August 5, 2022

Updated

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

v0.10.3

April 7, 2021
April 7, 2021

Added

  • Added connection to authorization_url (#78)

v0.10.2

March 3, 2021
March 3, 2021

Added

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

v0.10.1

March 1, 2021
March 1, 2021

Added

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

v0.10.0

February 4, 2021
February 4, 2021

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)

v0.9.2

December 9, 2020
December 9, 2020

Updated

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

Fixed

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