github4s
API
Generated with
github4s/github4s.interpreters/AuthInterpreter

AuthInterpreter

github4s.interpreters.AuthInterpreter
class AuthInterpreter[F[_]](implicit evidence$1: Applicative[F], client: HttpClient[F]) extends Auth[F]

Attributes

Graph
Supertypes
trait Auth[F]
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def authorizeUrl(client_id: String, redirect_uri: String, scopes: List[String]): F[GHResponse[Authorize]]

Generates the authorize url with a random state, both are returned within Authorize object

Generates the authorize url with a random state, both are returned within Authorize object

Attributes

client_id

the 20 character OAuth app client key for which to create the token

redirect_uri

the URL in your app where users will be sent after authorization

scopes

attached to the token

Returns:

GHResponse[Authorize] new state: first step oAuth

Definition Classes
override def getAccessToken(client_id: String, client_secret: String, code: String, redirect_uri: String, state: String, headers: Map[String, String]): F[GHResponse[OAuthToken]]

Requests an access token based on the code retrieved in the first step of the oAuth process

Requests an access token based on the code retrieved in the first step of the oAuth process

Attributes

client_id

the 20 character OAuth app client key for which to create the token

client_secret

the 40 character OAuth app client secret for which to create the token

code

the code you received as a response to Step 1

headers

optional user headers to include in the request

redirect_uri

the URL in your app where users will be sent after authorization

state

the unguessable random string you optionally provided in Step 1

Returns:

GHResponse[OAuthToken] new access_token: second step oAuth

Definition Classes
Generated with