README
¶
WorkOS Go Library
The WorkOS library for Go provides convenient access to the WorkOS API from applications written in Go.
Documentation
See the API Reference for Go usage examples.
Installation
Install the package with:
go get -u github.com/2adventure-Studios/workos-go/...
Configuration
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>")
SDK Versioning
For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.
More Information
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
pkg
|
|
|
auditlogs
Package `auditlogs` provides a client wrapping the WorkOS Audit Logs API.
|
Package `auditlogs` provides a client wrapping the WorkOS Audit Logs API. |
|
audittrail
Package `audittrail` provides a client wrapping the WorkOS Audit Trail API.
|
Package `audittrail` provides a client wrapping the WorkOS Audit Trail API. |
|
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. |