WorkOS Docs Homepage
SDKs
DashboardSign In
SDKs

Go SDK

github.com
workos/workos-go
43 Stars
14 Forks
38 Contributors
github.com
Official Go SDK for interacting with the WorkOS API.

Installation

Command Line
Go

Releases

v4.6.0

April 11, 2024
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)

v4.5.0

April 5, 2024
April 5, 2024

Added

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

v4.4.1

April 4, 2024
April 4, 2024

Changed

  • Fixed parameters organization and connection to organization_id and connection_id (#318)

v4.4.0

March 29, 2024
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

v4.3.0

March 21, 2024
March 21, 2024

Added

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

v4.2.0

March 20, 2024
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.

v4.1.0

March 19, 2024
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)

v4.0.0

March 8, 2024
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

v3.2.0

February 7, 2024
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

v3.1.0

December 5, 2023
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

v3.0.0

November 22, 2023
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

v2.4.2

October 27, 2023
October 27, 2023

What's Changed

  • Fix pagination for User Management list endpoints (#267)

v2.4.1

October 23, 2023
October 23, 2023

What's Changed

  • Add User Management Constants

v2.4.0

October 20, 2023
October 20, 2023

What's Changed

  • Add events as string constants

v2.3.0

September 14, 2023
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

v2.2.2

August 16, 2023
August 16, 2023

What's Changed

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

v2.2.1

August 11, 2023
August 11, 2023

What's Changed

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

v2.2.0

August 11, 2023
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

v2.1.4

July 14, 2023
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

v2.1.3

June 26, 2023
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)

v2.1.2

June 14, 2023
June 14, 2023

What's Changed

  • Added Events API beta

v2.1.1

May 10, 2023
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

v2.1.0

March 9, 2023
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)

v2.0.2

January 30, 2023
January 30, 2023

Updates module paths to v2

v2.0.1

December 12, 2022
December 12, 2022

What's Changed

  • Update MFA naming as follows: ChallengeOpts → ChallengeFactorOpts VerifyChallengeOpts.AuthenticationChallengeID → VerifyChallengeOpts.ChallengeID

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

v2.0.0

December 8, 2022
December 8, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-go/pull/193)
  • Made #189

Breaking Changes

  • Improve SSO and Passwordless naming consistency (https://github.com/workos/workos-go/pull/193)
    • GetProfileOptions → GetProfileOpts
    • GetProfileAndTokenOptions → GetProfileAndTokenOpts
    • GetAuthorizationURLOptions → GetAuthorizationURLOpts
    • passwordless.SendSessionOpts.ID → passwordless.SendSessionOpts.SessionID
  • mfa: Make client functions more consistent (https://github.com/workos/workos-go/pull/189)
    • All mfa.Client methods now utilize provided ctx.
    • Removed log.Panic in favour of returning errors.
    • All mfa.Client methods now utilize the client's HTTPClient.
    • Added defers for response bodies.
    • Utilize http.Method* constants instead of strings.
    • Have Client.VerifyFactor call it's receiver, not DefaultClient.
  • MFA improvements (https://github.com/workos/workos-go/pull/188)
    • EnrollResponse updated to Factor
    • ChallengeResponse updated to Challenge
    • GetEnrollOpts updated to EnrollFactorOpts
    • VerifyOpts updated to VerifyChallengeOpts
    • Capitalized AuthenticationFactor fields to SMS and TOTP
    • Created type FactorType with SMS and TOTP enums & updated Factor and EnrollFactorOpts accordingly
    • Created TOTPDetails and SMSDetails structs
    • Changed VerifyResponse to be named `VerifyChallengeResponse
  • Standardise return type of VerifyChallenge and coalesce errors into Error (https://github.com/workos/workos-go/pull/187)

v1.21.0

November 14, 2022
November 14, 2022

Changed

  • Add GetLoginHandler to sso.Client (https://github.com/workos/workos-go/pull/180)

v1.20.0

November 11, 2022
November 11, 2022

Changed

  • Cleaned inconsistencies on Audit Logs Client #181 #183

v1.19.0

October 25, 2022
October 25, 2022

Changed

  • Add CreatedAt and UpdatedAt to User in https://github.com/workos/workos-go/pull/175
  • Add support for DeleteFactor and GetFactor methods in https://github.com/workos/workos-go/pull/172
  • Add PrimaryEmail method for Directory User by in https://github.com/workos/workos-go/pull/169

v1.18.0

October 18, 2022
October 18, 2022

Added

  • SuccessURL to GenerateLinkOpts by in https://github.com/workos/workos-go/pull/177