DashboardSign In

Installation

Command Line
Go

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

June 4, 2024

v4.13.0

Latest
June 4, 2024

Added

  • Added a method to find an invitation using the token (#346)
June 3, 2024

v4.12.0

June 3, 2024

Added

  • Added support for TOTPSecret on usermanagement.EnrollAuthFactor (#345)
  • Added the list identities endpoint and Identity struct to the usermanagement package.
May 28, 2024

v4.11.0

May 28, 2024

Added

  • Added role to Directory User (https://github.com/workos/workos-go/pull/339)
May 24, 2024

v4.10.0

May 24, 2024

Added

  • Added InviterUserID to invitation object returned by API (#340)
  • Add support for email_verification.created and password_reset.created (#340)
  • Added new endpoints to the User Management API to support sending your own emails: GetEmailVerification, GetPasswordReset, and CreatePasswordReset (#340)
  • Deprecation notice for the SendPasswordResetEmail method in favor of CreatePasswordReset (#340)

Removed

  • Removed authentication events (#336)
May 17, 2024

v4.9.0

May 17, 2024

What's Changed

  • Add organization membership deactivate and reactivate API methods by @mattgd in https://github.com/workos/workos-go/pull/334

Full Changelog: https://github.com/workos/workos-go/compare/v4.8.0...v4.9.0

May 3, 2024

v4.8.0

May 3, 2024

Added

  • Added AcceptInvitationUrl to invitation object returned by API (#332)
  • Added new event types: invitation.created and magic_auth.created (#332)
  • Added new endpoints for the Magic Auth API: GetMagicAuth and CreateMagicAuth (#332)
  • Deprecation notice for SendMagicAuthCode method in favor of CreateMagicAuth (#332)
April 30, 2024

v4.7.0

April 30, 2024

Added

  • Support organization_id params in the Events API (https://github.com/workos/workos-go/pull/330)
  • Support organization_membership.added and organization_membership.deleted events (https://github.com/workos/workos-go/pull/328)
  • Add DomainData field to Organization create and update functions and deprecate Domains (https://github.com/workos/workos-go/pull/327)
April 11, 2024

v4.6.0

April 11, 2024

Added

  • Added password_hash and password_hash_type to CreateUser options (#324)

Changed

  • Require the events parameter when calling the list events API for new usages (#325)
April 5, 2024

v4.5.0

April 5, 2024

Added

  • Added optional role_slug parameter to send invitation payload to specify a user's organization membership role when inviting (#322)
April 4, 2024

v4.4.1

April 4, 2024

Changed

  • Fixed parameters organization and connection to organization_id and connection_id (#318)
March 29, 2024

v4.4.0

March 29, 2024

What's Changed

  • Add screen hint to GetAuthorizationURLOpts

Full Changelog: https://github.com/workos/workos-go/compare/v4.3.0...v4.4.0

March 21, 2024

v4.3.0

March 21, 2024

Added

  • Add session.created event (https://github.com/workos/workos-go/pull/313)
March 20, 2024

v4.2.0

March 20, 2024

Removed

  • Remove separate user.impersonated event (https://github.com/workos/workos-go/pull/311)
    • This event was never emitted by the API and has been superseded by session.created.
March 19, 2024

v4.1.0

March 19, 2024

Added

  • Role to Organization Membership, and new PUT endpoint for OrganizationMemberships API (#308)
  • Impersonation-related fields and event (#307)
  • Session endpoints (#309)
March 8, 2024

v4.0.0

March 8, 2024

Changed

  • Changed all resource list methods to default to descending order (#306)

Added

  • Added status to organization membership (#305)

Full Changelog: https://github.com/workos/workos-go/compare/v3.2.0...v4.0.0

February 7, 2024

v3.2.0

February 7, 2024

Added

  • Add ProfilePictureURL to User struct by @mthadley in https://github.com/workos/workos-go/pull/302

Removed

  • Remove "suspended" state from Directory Sync user object by @ameesha in https://github.com/workos/workos-go/pull/300

Full Changelog: https://github.com/workos/workos-go/compare/v3.1.0...v3.2.0

December 5, 2023

v3.1.0

December 5, 2023

Added

  • Stable release of usermanagement package, a wrapper around the User Management API
  • Added all supported directory types (https://github.com/workos/workos-go/pull/296)

Removed

  • Removed SCIM v1 directory types, which are no longer supported (https://github.com/workos/workos-go/pull/296)

Upgrading from Beta User Management API

If you're upgrading from a beta version of the User Management API, contact us at support@workos.com for a full changelog and assistance upgrading.

Full Changelog: https://github.com/workos/workos-go/compare/v3.0.0...v3.1.0

November 22, 2023

v3.0.0

November 22, 2023

Removed

  • [Breaking Change] Removed deprecated Audit Trail package (#279)
  • [Breaking Change] Removed beta version of the users package. Stable User Management release coming soon! (#279)

Full Changelog: https://github.com/workos/workos-go/compare/v2.4.2...v3.0.0

October 27, 2023

v2.4.2

October 27, 2023

What's Changed

  • Fix pagination for User Management list endpoints (#267)
October 23, 2023

v2.4.1

October 23, 2023

What's Changed

  • Add User Management Constants
October 20, 2023

v2.4.0

October 20, 2023

What's Changed

  • Add events as string constants
September 14, 2023

v2.3.0

September 14, 2023

What's Changed

  • Rename AuthenticateUserWithToken to AuthenticateUserWithCode https://github.com/workos/workos-go/pull/242
  • Drop session endpoints https://github.com/workos/workos-go/pull/243
  • Remove MagicAuthChallenge from public interface https://github.com/workos/workos-go/pull/244
  • User type updates https://github.com/workos/workos-go/pull/245
  • Fix authenticate methods https://github.com/workos/workos-go/pull/246
  • Add Users.DeleteUser() method https://github.com/workos/workos-go/pull/247
  • Fix Users.UpdateUserPassword() path https://github.com/workos/workos-go/pull/250
  • Update Email Verification methods https://github.com/workos/workos-go/pull/251
  • Rename AuthenticateUserWith_ to AuthenticateWith_ https://github.com/workos/workos-go/pull/252
  • Adds missing tests for AuthenticateWithMagicAuth and SendMagicAuthCode https://github.com/workos/workos-go/pull/253
  • Add users.EnrollAuthFactor() method https://github.com/workos/workos-go/pull/254
  • Add users.ListAuthFactor() method https://github.com/workos/workos-go/pull/255
  • Add users.AuthenticateWithTOTP() method https://github.com/workos/workos-go/pull/256
  • Rename password reset methods https://github.com/workos/workos-go/pull/257
  • Update /users/magic_auth/send to take email rather than email_address https://github.com/workos/workos-go/pull/258
  • Fix SendMagicAuthCode response type https://github.com/workos/workos-go/pull/259
  • Fix users.ListAuthFactor() return type https://github.com/workos/workos-go/pull/260
August 16, 2023

v2.2.2

August 16, 2023

What's Changed

  • Fix grant type on AuthenticateUserWithPasswordOpts in https://github.com/workos/workos-go/pull/240
August 11, 2023

v2.2.1

August 11, 2023

What's Changed

  • (FIX) Add ClientID to AuthenticateUserWithPasswordOpts in https://github.com/workos/workos-go/pull/238
August 11, 2023

v2.2.0

August 11, 2023

What's Changed

  • Introduce User Management package in https://github.com/workos/workos-go/pull/233 https://github.com/workos/workos-go/pull/235 https://github.com/workos/workos-go/pull/236
July 14, 2023

v2.1.4

July 14, 2023

What's Changed

  • Add devbox by @AshGodfrey in https://github.com/workos/workos-go/pull/212
  • Use list_metadata instead of listMetadata for events by @AshGodfrey in https://github.com/workos/workos-go/pull/215
June 26, 2023

v2.1.3

June 26, 2023

What's Changed

  • Changed the Events API (in beta) rangeStart and rangeEnd parameters to range_start and range_end (https://github.com/workos/workos-go/pull/210)
June 14, 2023

v2.1.2

June 14, 2023

What's Changed

  • Added Events API beta
May 10, 2023

v2.1.1

May 10, 2023

What's Changed

  • Add ActorNames/ActorIds to CreateExportOpts by @cmatheson in https://github.com/workos/workos-go/pull/204
  • Add validating state to connection enums by @AshGodfrey in https://github.com/workos/workos-go/pull/205
March 9, 2023

v2.1.0

March 9, 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. (#200)