[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# signet - Module Signet::OAuth2 (v0.21.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.21.0 (latest)](/ruby/docs/reference/signet/latest/Signet-OAuth2)\n- [0.20.0](/ruby/docs/reference/signet/0.20.0/Signet-OAuth2) \nReference documentation and code samples for the signet module Signet::OAuth2.\n\nAn implementation of \u003chttp://tools.ietf.org/html/draft-ietf-oauth-v2-10\u003e\n\n\n\u003cbr /\u003e\n\nThis module will be updated periodically to support newer drafts of the\nspecification, as they become widely deployed.\n\nMethods\n-------\n\n### .generate_authorization_uri\n\n def self.generate_authorization_uri(authorization_uri, parameters = {}) -\u003e String\n\nAppends the necessary OAuth parameters to\nthe base authorization endpoint URI. \n**Parameter**\n\n- **authorization_uri** (Addressable::URI, String, #to_str) --- The base authorization endpoint URI. \n**Returns**\n\n- (String) --- The authorization URI to redirect the user to.\n\n### .generate_basic_authorization_header\n\n def self.generate_basic_authorization_header(client_id, client_password) -\u003e String\n\nGenerates a Basic Authorization header from a client identifier and a\nclient password. \n**Parameters**\n\n- **client_id** (String) --- The client identifier.\n- **client_password** (String) --- The client password. \n**Returns**\n\n- (String) --- The value for the HTTP Basic Authorization header.\n\n### .generate_bearer_authorization_header\n\n def self.generate_bearer_authorization_header(access_token, auth_params = nil) -\u003e String\n\nGenerates an authorization header for an access token \n**Parameters**\n\n- **access_token** (String) --- The access token.\n- **auth_params** (Hash) --- Additional parameters to be encoded in the header \n**Returns**\n\n- (String) --- The value for the HTTP Basic Authorization header.\n\n### .parse_authorization_header\n\n def self.parse_authorization_header(field_value)\n\n### .parse_basic_credentials\n\n def self.parse_basic_credentials(credential_string)\n\n### .parse_bearer_credentials\n\n def self.parse_bearer_credentials(credential_string)\n\n### .parse_credentials\n\n def self.parse_credentials(body, content_type)\n\n**Raises**\n\n- (TypeError)\n\n### .parse_oauth_challenge\n\n def self.parse_oauth_challenge(challenge_string)\n\n### .parse_www_authenticate_header\n\n def self.parse_www_authenticate_header(field_value)"]]
