WorkOS Ruby Library
The WorkOS library for Ruby provides convenient access to the WorkOS API from applications written in Ruby.
Documentation
See the API Reference for Ruby usage examples.
Installation
Install the package with:
gem install workos
If you're using Bundler to manage your application's gems, add the WorkOS gem to your Gemfile:
source 'https://rubygems.org'
gem 'workos'
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=[your api key] ruby app.rbOr, you may set the key yourself, such as in an initializer in your application load path:
# /config/initializers/workos.rb
WorkOS.key = '[your 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.