Project

workos

0.02
The project is in a healthy, maintained state
API client for WorkOS
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

>= 2.0.1
~> 0.2.8
>= 0
~> 3.9.0
~> 0.77
~> 0.5
~> 5.0.0
>= 0

Runtime

 Project Readme

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.rb

Or, 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]'

More Information