{"repo":"workos/workos-ruby","free":true,"listed":false,"github":"https://github.com/workos/workos-ruby","clone":"git clone https://github.com/workos/workos-ruby.git","description":"Official Ruby SDK for interacting with the WorkOS API","language":"Ruby","stars":39,"topics":["sso","sso-authentication","saml","okta","azure-active-directory","audit-logs","scim","adfs","gsuite-saml-apps","directory-sync"],"license":"MIT","category":"auth-billing-email","readme_excerpt":"WorkOS Ruby Library The WorkOS Ruby SDK provides convenient access to the WorkOS API from applications written in Ruby. Documentation - Ruby SDK documentation - API reference Installation Install the package with: If you're using Bundler to manage your application's gems, add the WorkOS gem to your Gemfile: Configuration Store your WorkOS API key (and, for AuthKit and SSO flows, your client ID) in environment variables such as WORKOS API KEY and WORKOS CLIENT ID , then pass them to the SDK explicitly. The SDK does not read these environment variables automatically — configure it in an initializer: Client patterns Singleton (recommended for most apps) Multi-tenant (one client per API key) Public / PKCE (browser, mobile, CLI) Fork safety (Puma / Unicorn) The SDK caches persistent connections per fiber. After forking, call WorkOS.reset client (or client.shutdown ) to close inherited sockets: Per-request options Every method that makes an HTTP request accepts request options: for per-call overrides (local URL-building helpers such as get authorization url and get logout url do not): Idempotency-Key is only sent on POST , PUT , and PATCH requests — either when you provide request options[:idempotency key] , or auto-generated when the SDK retries one of those requests after a transient failure. It is never attached to GET or DELETE requests. [!NOTE] The WorkOS API currently honors Idempotency-Key only on the Create Audit Log Event endpoint ( audit logs.create event ). Other endpoin","default_branch":null,"files":null,"tree":[],"storefront":"/r/workos","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/workos/workos-ruby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}