Exception: Octokit::OneTimePasswordRequired

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `ClientError`, `Error`, StandardError
Instance Chain: self, `ClientError`, `Error`, StandardError
Inherits:	Octokit::ClientError Object StandardError Octokit::Error Octokit::ClientError Octokit::OneTimePasswordRequired
Defined in:	lib/octokit/error.rb

Overview

Raised when GitHub returns a 401 HTTP status code and headers include "X-GitHub-OTP"

OTP_DELIVERY_PATTERN = Internal use only
# File 'lib/octokit/error.rb', line 231
```
/required; (\w+)/i.freeze
```

.error_for_401	Returns most appropriate error for 401 HTTP status code.
.error_for_403	Returns most appropriate error for 403 HTTP status code.
.error_for_404	Return most appropriate error for 404 HTTP status code.
.error_for_422	Return most appropriate error for 422 HTTP status code.
.from_response	Returns the appropriate `Error` subclass based on status and response message.
.new

#context

#build_error_context,
#documentation_url	Documentation URL returned by the API for some errors.
#errors	Array of validation errors.
#response_body	Body returned by the GitHub server.
#response_headers	Headers returned by the GitHub server.
#response_status	Status code returned by the GitHub server.
#build_error_message, #data, #redact_url, #response_error, #response_error_summary, #response_message

This class inherits a constructor from Octokit::Error

This method is for internal use only.

[ GitHub ]

# File 'lib/octokit/error.rb', line 234


def self.required_header(headers)
  OTP_DELIVERY_PATTERN.match headers['X-GitHub-OTP'].to_s
end

[ GitHub ]

# File 'lib/octokit/error.rb', line 247


def delivery_method_from_header
  if match = self.class.required_header(@response[:response_headers])
    match[1]
  end
end

Delivery method for the user's OTP

[ GitHub ]

# File 'lib/octokit/error.rb', line 241


def password_delivery
  @password_delivery ||= delivery_method_from_header
end