{"id":18000130,"url":"https://github.com/codesandbox/ueberauth_workos","last_synced_at":"2025-03-26T07:32:02.897Z","repository":{"id":95478515,"uuid":"607752287","full_name":"codesandbox/ueberauth_workos","owner":"codesandbox","description":"Ueberauth Strategy for WorkOS Single Sign-On","archived":false,"fork":false,"pushed_at":"2024-07-18T09:16:10.000Z","size":36,"stargazers_count":10,"open_issues_count":3,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-19T06:46:00.845Z","etag":null,"topics":["elixir","oauth","phoenix","ueberauth","workos"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codesandbox.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-28T15:55:27.000Z","updated_at":"2025-03-14T18:27:12.000Z","dependencies_parsed_at":"2024-10-29T23:40:08.333Z","dependency_job_id":null,"html_url":"https://github.com/codesandbox/ueberauth_workos","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"0cdc1a76496a29dbf6b2457df37b6bff32d301b6"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesandbox%2Fueberauth_workos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesandbox%2Fueberauth_workos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesandbox%2Fueberauth_workos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codesandbox%2Fueberauth_workos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codesandbox","download_url":"https://codeload.github.com/codesandbox/ueberauth_workos/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245611753,"owners_count":20643892,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir","oauth","phoenix","ueberauth","workos"],"created_at":"2024-10-29T23:09:45.901Z","updated_at":"2025-03-26T07:32:02.619Z","avatar_url":"https://github.com/codesandbox.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ueberauth WorkOS\n\n[![Hex.pm](https://img.shields.io/hexpm/v/ueberauth_workos)](https://hex.pm/packages/ueberauth_workos)\n[![Documentation](https://img.shields.io/badge/hex-docs-blue)](https://hexdocs.pm/ueberauth_workos)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)\n\nUeberauth strategy for integrating with WorkOS Single Sign-On\n\n## Quick Start\n\nFor detailed instructions, see [Getting Started](guides/getting-started.md).\n\n### Installation\n\nAdd `ueberauth_workos` as a dependency in `mix.exs` and run `mix deps.get`:\n\n```elixir\ndef deps do\n  [\n    {:ueberauth, \"~\u003e 0.10\"},\n    {:ueberauth_workos, \"~\u003e 0.0.3\"}\n  ]\nend\n```\n\n**Warning**: This package is in early development, and not suitable for production use.\n\n### Configuration\n\nThis strategy requires two pieces of configuration.\nBecause these values are likely to change between environments, and should be kept secret, we recommend using runtime configuration (for example, `config/runtime.exs`).\n\n* `api_key`: (**Required**) WorkOS API key, which also acts as the OAuth client secret. This key\n  is environment-specific and must match the environment of the `client_id`..\n\n* `client_id`: (**Required**) OAuth client ID obtained from WorkOS. This ID is environment-specific\n  and must match the environment of the `api_key`.\n\nThe following configuration is optional:\n\n* `callback_url`: Redirect URI to send users for the callback phase of OAuth. This URL must be\n  allowed in the WorkOS configuration for the environment matching the client ID. By default,\n  Ueberauth will construct a callback URL using the Phoenix endpoint host and the provider name.\n\nYou may include these options directly in the provider configuration, if it occurs in the appropriate configuration file:\n\n```elixir\nconfig :ueberauth, Ueberauth,\n  providers: [\n    workos: {Ueberauth.Strategy.WorkOS, [\n      api_key: System.fetch_env!(\"WORKOS_API_KEY\"),\n      client_id: System.fetch_env!(\"WORKOS_CLIENT_ID\")\n    ]}\n  ]\n```\n\nAlternatively, you may configure the strategy module directly.\nThis can be useful if you wish to place this in a separate configuration file:\n\n```elixir\nconfig :ueberauth, Ueberauth.Strategy.WorkOS,\n  api_key: System.fetch_env!(\"WORKOS_API_KEY\"),\n  client_id: System.fetch_env!(\"WORKOS_CLIENT_ID\")\n```\n\n**Remember**: It is recommended to use runtime configuration for the API key and client ID.\n\n### Integration\n\nMuch of the setup for this strategy will be familiar if you have integrated with other Ueberauth strategies.\nHowever, there is one additional step necessary: a redirect or plug that supplies connection information to the request phase.\n\nUnique to this strategy is the need for a _Connection Selector_ during the request phase.\nFor detailed instructions, see [Getting Started](guides/getting-started.md).\n\n## License\n\nPlease see [LICENSE](LICENSE) for licensing details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesandbox%2Fueberauth_workos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodesandbox%2Fueberauth_workos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodesandbox%2Fueberauth_workos/lists"}