Skip to content

abstract class OAuth2::AccessToken
inherits Reference

Base class for the two possible access tokens: Bearer and Mac.

Use #authenticate to authenticate an HTTP::Client.

Direct known subclasses

OAuth2::AccessToken::Bearer OAuth2::AccessToken::Mac

Class methods

.new(access_token : String, expires_in : Int?, refresh_token : String? = nil, scope : String? = nil, extra = nil)

View source

Methods

#access_token : String

View source

#access_token=(access_token : String)

View source

abstract #authenticate(request : HTTP::Request, tls)

View source

#authenticate(client : HTTP::Client)

View source

#expires_in : Int64?

View source

#expires_in=(expires_in : Int64?)

View source

#extra : Hash(String, String)?

JSON key-value pairs that are outside of the OAuth2 spec are stored in this property in case they are needed. Their value is the raw JSON string found in the JSON value (with possible changes in the string format, but preserving JSON semantic). For example if the value was [1, 2, 3] then the value in this hash will be the string "[1,2,3]".

View source

#extra=(extra : Hash(String, String)?)

JSON key-value pairs that are outside of the OAuth2 spec are stored in this property in case they are needed. Their value is the raw JSON string found in the JSON value (with possible changes in the string format, but preserving JSON semantic). For example if the value was [1, 2, 3] then the value in this hash will be the string "[1,2,3]".

View source

#refresh_token : String?

View source

#refresh_token=(refresh_token : String?)

View source

#scope=(scope : String?)

View source