workos-go

module

v1.9.0 Latest Latest Go to latest Published: Mar 15, 2022 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

The WorkOS library for Go provides convenient access to the WorkOS API from applications written in Go.

See the API Reference for Go usage examples.

Install the package with:

go get -u github.com/gosdktest/workos-go/...

To use the library you must provide an API key, located in the WorkOS dashboard, as an environment variable WORKOS_API_KEY:

WORKOS_API_KEY="sk_1234"

Or, you can set it on your own before your application starts:

sso.Configure(
  "<WORKOS_API_KEY>",
  "<CLIENT_ID>",
  "https://foo-corp.com/redirect-uri",
)

directorysync.SetAPIKey("<WORKOS_API_KEY>")

Path	Synopsis
internal
workos
pkg
audittrail Package `audittrail` provides a client wrapping the WorkOS Audit Trail API.	Package `audittrail` provides a client wrapping the WorkOS Audit Trail API.
common
directorysync Package `directorysync` provides a client wrapping the WorkOS Directory Sync API.	Package `directorysync` provides a client wrapping the WorkOS Directory Sync API.
organizations Package `organizations` provides a client wrapping the WorkOS Organizations API.	Package `organizations` provides a client wrapping the WorkOS Organizations API.
passwordless Package `passwordless` provides a client wrapping the WorkOS Magic Link API.	Package `passwordless` provides a client wrapping the WorkOS Magic Link API.
portal Package `portal` provides a client wrapping the WorkOS Admin Portal API.	Package `portal` provides a client wrapping the WorkOS Admin Portal API.
sso Package `sso` provides a client wrapping the WorkOS SSO API.	Package `sso` provides a client wrapping the WorkOS SSO API.
webhooks
workos_errors