Table of Contents - oauth2 - OAuth 2.0 Core Ruby implementation
Pages
-
CHANGELOG
- Changelog
- Unreleased
- Added
- Changed
- Deprecated
- Removed
- Fixed
- Security
- 2.0.12 - 2025-05-31
- Added
- Changed
- Deprecated
- Removed
- Fixed
- Security
- 2.0.11 - 2025-05-23
- Added
- Changed
- Fixed
- 2.0.10 - 2025-05-17
- Added
- Changed
- Fixed
- 2.0.9 - 2022-09-16
- Added
- Changed
- 2.0.8 - 2022-09-01
- Changed
- Added
- 2.0.7 - 2022-08-22
- Added
- Fixed
- 2.0.6 - 2022-07-13
- Fixed
- 2.0.5 - 2022-07-07
- Fixed
- 2.0.4 - 2022-07-01
- Fixed
- 2.0.3 - 2022-06-28
- Added
- Fixed
- 2.0.2 - 2022-06-24
- Fixed
- 2.0.1 - 2022-06-22
- Added
- 2.0.0 - 2022-06-21
- Added
- Changed
- Fixed
- Removed
- 1.4.11 - 2022-09-16
- 1.4.10 - 2022-07-01
- 1.4.9 - 2022-02-20
- 1.4.8 - 2022-02-18
- 1.4.7 - 2021-03-19
- 1.4.6 - 2021-03-19
- 1.4.5 - 2021-03-18
- 1.4.4 - 2020-02-12
- 1.4.3 - 2020-01-29
- 1.4.2 - 2019-10-01
- 1.4.1 - 2018-10-13
- 1.4.0 - 2017-06-09
- 1.3.1 - 2017-03-03 (tag)
- 1.3.0 - 2016-12-28 (tag)
- 1.2.0 - 2016-07-01 (tag)
- 1.1.0 - 2016-01-30 (tag)
- 1.0.0 - 2014-07-09 (tag)
- Added
- Fixed
- 0.5.0 - 2011-07-29 (tag)
- Changed
- 0.4.1 - 2011-04-20 (tag)
- 0.4.0 - 2011-04-20 (tag)
- 0.3.0 - 2011-04-08 (tag)
- 0.2.0 - 2011-04-01 (tag)
- 0.1.1 - 2011-01-12 (tag)
- 0.1.0 - 2010-10-13 (tag)
- 0.0.13 - 2010-08-17 (tag)
- 0.0.12 - 2010-08-17 (tag)
- 0.0.11 - 2010-08-17 (tag)
- 0.0.10 - 2010-06-19 (tag)
- 0.0.9 - 2010-06-18 (tag)
- 0.0.8 - 2010-04-27 (tag)
- 0.0.7 - 2010-04-27 (tag)
- 0.0.6 - 2010-04-25 (tag)
- 0.0.5 - 2010-04-23 (tag)
- 0.0.4 - 2010-04-22 (tag)
- 0.0.3 - 2010-04-22 (tag)
- 0.0.2 - 2010-04-22 (tag)
- 0.0.1 - 2010-04-22 (tag)
- CODE_OF_CONDUCT
- CONTRIBUTING
- LICENSE
-
README
- π OAuth2
- Upgrading Runtime Gem Dependencies
- You should upgrade this gem with confidence*.
- Quick Usage Example for AI and Copy / Pasting
- π‘ Info you can shake a stick at
- π Release Documentation
- Version 2.0.x
- Older Releases
- β¨ Installation
- π Secure Installation
- OAuth2 for Enterprise
- Security contact information
- What is new for v2.0?
- Compatibility
- π§ Basic Usage
- Global Configuration
authorize_url
andtoken_url
are on site root (Just Works!)- Relative
authorize_url
andtoken_url
(Not on site root, Just Works!) - Customize
authorize_url
andtoken_url
- snake_case and indifferent access in Response#parsed
- Serialization
- Serialization Extensions
- What if I hate snakes and/or indifference?
- OAuth2::Response
- OAuth2::AccessToken
- OAuth2::Error
- Authorization Grants
- π Security
- π€ Contributing
- π Release Instructions
- Code Coverage
- πͺ Code of Conduct
- π Contributors
- βοΈ Star History
- π Versioning
- π Is βPlatform Supportβ part of the public API?
- π License
- Β© Copyright
- π€ One more thing
- SECURITY
Classes and Modules
- OAuth2
- OAuth2::AccessToken
- OAuth2::Authenticator
- OAuth2::Client
- OAuth2::Error
- OAuth2::FilteredAttributes
- OAuth2::FilteredAttributes::ClassMethods
- OAuth2::Response
- OAuth2::Strategy
- OAuth2::Strategy::Assertion
- OAuth2::Strategy::AuthCode
- OAuth2::Strategy::Base
- OAuth2::Strategy::ClientCredentials
- OAuth2::Strategy::Implicit
- OAuth2::Strategy::Password
- OAuth2::Version
Methods
- ::configure — OAuth2
- ::encode_basic_auth — OAuth2::Authenticator
- ::extra_tokens_warning — OAuth2::AccessToken
- ::from_hash — OAuth2::AccessToken
- ::from_kvform — OAuth2::AccessToken
- ::included — OAuth2::FilteredAttributes
- ::new — OAuth2::AccessToken
- ::new — OAuth2::Authenticator
- ::new — OAuth2::Client
- ::new — OAuth2::Error
- ::new — OAuth2::Response
- ::new — OAuth2::Strategy::Base
- ::no_tokens_warning — OAuth2::AccessToken
- ::register_parser — OAuth2::Response
- #[] — OAuth2::AccessToken
- #apply — OAuth2::Authenticator
- #apply_basic_auth — OAuth2::Authenticator
- #apply_client_id — OAuth2::Authenticator
- #apply_params_auth — OAuth2::Authenticator
- #assert_valid_params — OAuth2::Strategy::AuthCode
- #assert_valid_params — OAuth2::Strategy::Implicit
- #assertion — OAuth2::Client
- #auth_code — OAuth2::Client
- #authenticator — OAuth2::Client
- #authorize_params — OAuth2::Strategy::AuthCode
- #authorize_params — OAuth2::Strategy::Implicit
- #authorize_url — OAuth2::Client
- #authorize_url — OAuth2::Strategy::Assertion
- #authorize_url — OAuth2::Strategy::AuthCode
- #authorize_url — OAuth2::Strategy::ClientCredentials
- #authorize_url — OAuth2::Strategy::Implicit
- #authorize_url — OAuth2::Strategy::Password
- #basic_auth_header — OAuth2::Authenticator
- #body — OAuth2::Response
- #build_access_token — OAuth2::Client
- #build_access_token_legacy — OAuth2::Client
- #build_assertion — OAuth2::Strategy::Assertion
- #build_request — OAuth2::Strategy::Assertion
- #client_credentials — OAuth2::Client
- #configure — OAuth2
- #configure_authentication! — OAuth2::AccessToken
- #connection — OAuth2::Client
- #content_type — OAuth2::Response
- #convert_expires_at — OAuth2::AccessToken
- #delete — OAuth2::AccessToken
- #error_message — OAuth2::Error
- #execute_request — OAuth2::Client
- #expired? — OAuth2::AccessToken
- #expires? — OAuth2::AccessToken
- #filtered_attribute_names — OAuth2::FilteredAttributes::ClassMethods
- #filtered_attributes — OAuth2::FilteredAttributes::ClassMethods
- #get — OAuth2::AccessToken
- #get_token — OAuth2::Client
- #get_token — OAuth2::Strategy::Assertion
- #get_token — OAuth2::Strategy::AuthCode
- #get_token — OAuth2::Strategy::ClientCredentials
- #get_token — OAuth2::Strategy::Implicit
- #get_token — OAuth2::Strategy::Password
- #headers — OAuth2::AccessToken
- #headers — OAuth2::Response
- #http_method — OAuth2::Client
- #implicit — OAuth2::Client
- #inspect — OAuth2::FilteredAttributes
- #oauth_debug_logging — OAuth2::Client
- #params_to_req_opts — OAuth2::Client
- #parse_error_description — OAuth2::Error
- #parse_response — OAuth2::Client
- #parse_response_legacy — OAuth2::Client
- #parse_snaky_params_headers — OAuth2::Client
- #parsed — OAuth2::Response
- #parser — OAuth2::Response
- #password — OAuth2::Client
- #patch — OAuth2::AccessToken
- #post — OAuth2::AccessToken
- #put — OAuth2::AccessToken
- #redirection_params — OAuth2::Client
- #refresh — OAuth2::AccessToken
- #refresh! — OAuth2::AccessToken
- #request — OAuth2::AccessToken
- #request — OAuth2::Client
- #revoke — OAuth2::AccessToken
- #revoke! — OAuth2::AccessToken
- #revoke_token — OAuth2::Client
- #revoke_url — OAuth2::Client
- #site= — OAuth2::Client
- #status — OAuth2::Response
- #to_hash — OAuth2::AccessToken
- #token_url — OAuth2::Client