module WorkOS

Use the WorkOS module to authenticate your requests to the WorkOS API. The gem will read your API key automatically from the ENV var `WORKOS_API_KEY`. Alternatively, you can set the key yourself with `WorkOS.key = [your api key]` somewhere in the load path of your application, such as an initializer.

typed: true

typed: false

typed: true

typed: strong

typed: strict

typed: strong

Constants

API_HOSTNAME
VERSION

Public Class Methods

key() click to toggle source

# File lib/workos.rb, line 21
def self.key
  Base.key
end

key!() click to toggle source

# File lib/workos.rb, line 25
def self.key!
  key || raise('WorkOS.key not set')
end

key=(value) click to toggle source

# File lib/workos.rb, line 17
def self.key=(value)
  Base.key = value
end