{"id":15048198,"url":"https://github.com/github/omniauth","last_synced_at":"2025-10-04T10:30:36.980Z","repository":{"id":8133599,"uuid":"9551327","full_name":"github/omniauth","owner":"github","description":"OmniAuth is a flexible authentication system utilizing Rack middleware.","archived":true,"fork":false,"pushed_at":"2022-03-17T20:58:47.000Z","size":2975,"stargazers_count":18,"open_issues_count":1,"forks_count":20,"subscribers_count":282,"default_branch":"0-3-stable","last_synced_at":"2024-09-25T21:08:56.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://github.com/intridea/omniauth/wiki","language":"Ruby","has_issues":false,"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/github.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-19T18:00:46.000Z","updated_at":"2024-07-31T03:15:56.000Z","dependencies_parsed_at":"2022-09-10T23:00:31.159Z","dependency_job_id":null,"html_url":"https://github.com/github/omniauth","commit_stats":null,"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fomniauth","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fomniauth/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fomniauth/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/github%2Fomniauth/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/github","download_url":"https://codeload.github.com/github/omniauth/tar.gz/refs/heads/0-3-stable","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219876582,"owners_count":16554769,"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":[],"created_at":"2024-09-24T21:09:04.410Z","updated_at":"2025-10-04T10:30:36.624Z","avatar_url":"https://github.com/github.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OmniAuth: Standardized Multi-Provider Authentication\nOmniAuth is a new Rack-based authentication system for multi-provider external\nauthentcation. OmniAuth is built from the ground up on the philosophy that\n**authentication is not the same as identity**, and is based on two\nobservations:\n\n1. The traditional 'sign up using a login and password' model is becoming the\n   exception, not the rule. Modern web applications offer external\n   authentication via OpenID, Facebook, and/or OAuth.\n2. The interconnectable web is no longer a dream, it is a necessity. It is not\n   unreasonable to expect that one application may need to be able to connect\n   to one, three, or twelve other services. Modern authentication systems\n   should allow a user's identity to be associated with many authentications.\n\n## \u003ca name=\"installation\"\u003eInstallation\u003c/a\u003e\nTo install OmniAuth, simply install the gem:\n\n    gem install omniauth\n\n## \u003ca name=\"ci\"\u003eContinuous Integration\u003c/a\u003e\n[![Build Status](https://travis-ci.org/intridea/omniauth.png)](http://travis-ci.org/intridea/omniauth)\n\n## \u003ca name=\"providers\"\u003eProviders\u003c/a\u003e\nOmniAuth currently supports the following external providers:\n\n* via OAuth (OAuth 1.0, OAuth 2, and xAuth)\n  * 37signals ID (credit: [mbleigh](https://github.com/mbleigh))\n  * AngelList (credit: [joshuaxls](https://github.com/joshuaxls))\n  * Bit.ly (credit: [philnash](https://github.com/philnash))\n  * Blogger (credit: [dsueiro-backing](https://github.com/dsueiro-backing))\n  * Cobot (credit: [kamal](https://github.com/kamal))\n  * DailyMile (credit: [cdmwebs](https://github.com/cdmwebs))\n  * Doit.im (credit: [chouti](https://github.com/chouti))\n  * Dopplr (credit: [flextrip](https://github.com/flextrip))\n  * Douban (credit: [quake](https://github.com/quake))\n  * Evernote (credit: [szimek](https://github.com/szimek))\n  * Facebook (credit: [mbleigh](https://github.com/mbleigh))\n  * Foursquare (credit: [mbleigh](https://github.com/mbleigh))\n  * GitHub (credit: [mbleigh](https://github.com/mbleigh))\n  * Glitch (credit: [harrylove](https://github.com/harrylove))\n  * GoodReads (credit: [cristoffer](https://github.com/christoffer))\n  * Google Health (credit: [jaigouk](https://github.com/jaigouk))\n  * Gowalla (credit: [kvnsmth](https://github.com/kvnsmth))\n  * Hyves (credit: [mrdg](https://github.com/mrdg))\n  * Identi.ca (credit: [dcu](https://github.com/dcu))\n  * Flattr (credit: [dcu](https://github.com/dcu))\n  * Instagram (credit: [kiyoshi](https://github.com/kiyoshi))\n  * Instapaper (credit: [micpringle](https://github.com/micpringle))\n  * LastFM (credit: [tictoc](https://github.com/tictoc))\n  * LinkedIn (credit: [mbleigh](https://github.com/mbleigh))\n  * Mailchimp (via [srbiv](http://github.com/srbiv))\n  * Mailru (credit: [lexer](https://github.com/lexer))\n  * Meetup (credit [coderoshi](https://github.com/coderoshi))\n  * Miso (credit: [rickenharp](https://github.com/rickenharp))\n  * Mixi (credit: [kiyoshi](https://github.com/kiyoshi))\n  * Netflix (credit: [caged](https://github.com/caged))\n  * Orkut (credit: [andersonleite](https://github.com/andersonleite))\n  * Plurk (credit: [albb0920](http://github.com/albb0920))\n  * Qzone (credit: [quake](https://github.com/quake))\n  * Rdio (via [brandonweiss](https://github.com/brandonweiss))\n  * Renren (credit: [quake](https://github.com/quake))\n  * Salesforce (via [CloudSpokes](http://www.cloudspokes.com))\n  * SmugMug (credit: [pchilton](https://github.com/pchilton))\n  * SoundCloud (credit: [leemartin](https://github.com/leemartin))\n  * T163 (credit: [quake](https://github.com/quake))\n  * Taobao (credit: [l4u](https://github.com/l4u))\n  * TeamBox (credit [jrom](https://github.com/jrom))\n  * Tqq (credit: [quake](https://github.com/quake))\n  * TradeMe (credit: [pchilton](https://github.com/pchilton))\n  * TripIt (credit: [flextrip](https://github.com/flextrip))\n  * Tsina (credit: [quake](https://github.com/quake))\n  * Tsohu (credit: [quake](https://github.com/quake))\n  * Tumblr (credit: [jamiew](https://github.com/jamiew))\n  * Twitter (credit: [mbleigh](https://github.com/mbleigh))\n  * Viadeo (credit: [guillaug](https://github.com/guillaug))\n  * Vimeo (credit: [jamiew](https://github.com/jamiew))\n  * Vkontakte (credit: [german](https://github.com/german))\n  * WePay (credit: [ryanwood](https://github.com/ryanwood))\n  * Yahoo (credit: [mpd](https://github.com/mpd))\n  * Yammer (credit: [kltcalamay](https://github.com/kltcalamay))\n  * YouTube (credit: [jamiew](https://github.com/jamiew))\n* CAS (Central Authentication Service) (credit: [jamesarosen](https://github.com/jamesarosen))\n* Flickr (credit: [pchilton](https://github.com/pchilton))\n* Google Apps (via OpenID) (credit: [mbleigh](https://github.com/mbleigh))\n* Google OpenID+OAuth (via Hybrid Protocol) (credit: [boyvanamstel](https://github.com/boyvanamstel))\n* LDAP (credit: [pyu10055](https://github.com/pyu10055))\n* OpenID (credit: [mbleigh](https://github.com/mbleigh))\n* Yupoo (credit: [chouti](https://github.com/chouti))\n\n## \u003ca name=\"usage\"\u003eUsage\u003c/a\u003e\nOmniAuth is a collection of Rack middleware. To use a single strategy, you simply need to add the middleware:\n\n    require 'oa-oauth'\n    use OmniAuth::Strategies::Twitter, 'CONSUMER_KEY', 'CONSUMER_SECRET'\n\nNow to initiate authentication you merely need to redirect the user to `/auth/twitter` via a link or other means. Once the user has authenticated to Twitter, they will be redirected to `/auth/twitter/callback`. You should build an endpoint that handles this URL, at which point you will have access to the authentication information through the `omniauth.auth` parameter of the Rack environment. For example, in Sinatra you would do something like this:\n\n    get '/auth/twitter/callback' do\n      auth_hash = request.env['omniauth.auth']\n    end\n\nThe hash in question will look something like this:\n\n    {\n      'uid' =\u003e '12356',\n      'provider' =\u003e 'twitter',\n      'user_info' =\u003e {\n        'name' =\u003e 'User Name',\n        'nickname' =\u003e 'username',\n        # ...\n      }\n    }\n\nThe `user_info` hash will automatically be populated with as much information about the user as OmniAuth was able to pull from the given API or authentication provider.\n\n## \u003ca name=\"resources\"\u003eResources\u003c/a\u003e\nThe best place to find more information is the [OmniAuth Wiki](https://github.com/intridea/omniauth/wiki). Some specific information you might be interested in:\n\n* [CI Build Status](http://travis-ci.org/intridea/omniauth)\n* [Roadmap](https://github.com/intridea/omniauth/wiki/Roadmap)\n* [Changelog](https://github.com/intridea/omniauth/wiki/Changelog)\n* [Report Issues](https://github.com/intridea/omniauth/issues)\n* [Mailing List](http://groups.google.com/group/omniauth)\n\n## \u003ca name=\"core\"\u003eCore Team\u003c/a\u003e\n* **Michael Bleigh** ([mbleigh](https://github.com/mbleigh))\n* **Erik Michaels-Ober** ([sferik](https://github.com/sferik))\n\n## \u003ca name=\"rubies\"\u003eSupported Rubies\u003c/a\u003e\nThis library aims to support and is [tested\nagainst](http://travis-ci.org/intridea/omniauth) the following Ruby\nimplementations:\n\n* Ruby 1.8.7\n* Ruby 1.9.2\n* [JRuby](http://www.jruby.org/)\n* [Rubinius](http://rubini.us/)\n* [Ruby Enterprise Edition](http://www.rubyenterpriseedition.com/)\n\nIf something doesn't work on one of these interpreters, it should be considered\na bug.\n\nThis library may inadvertently work (or seem to work) on other Ruby\nimplementations, however support will only be provided for the versions listed\nabove.\n\nIf you would like this library to support another Ruby version, you may\nvolunteer to be a maintainer. Being a maintainer entails making sure all tests\nrun and pass on that implementation. When something breaks on your\nimplementation, you will be personally responsible for providing patches in a\ntimely fashion. If critical issues for a particular implementation exist at the\ntime of a major release, support for that Ruby version may be dropped.\n\n## \u003ca name=\"license\"\u003eLicense\u003c/a\u003e\nOmniAuth is released under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fomniauth","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithub%2Fomniauth","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithub%2Fomniauth/lists"}