GitHubOAuth2Client class

Implements an OAuth2 client against GitHub

In order to use this client you need to first create a new OAuth2 App in the GittHub Developer Settings (https://github.com/settings/developers)

Inheritance

Constructors

GitHubOAuth2Client({required String redirectUri, required String customUriScheme})

Properties

authorizeUrl ↔ String
getter/setter pairinherited
credentialsLocation ↔ CredentialsLocation
getter/setter pairinherited
customUriScheme ↔ String
getter/setter pairinherited
hashCode → int
The hash code for this object.
no setterinherited
redirectUri ↔ String
getter/setter pairinherited
refreshUrl ↔ String?
getter/setter pairinherited
revokeUrl ↔ String?
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scopeSeparator ↔ String
getter/setter pairinherited
tokenUrl ↔ String
getter/setter pairinherited
webAuthClient ↔ BaseWebAuth
getter/setter pairinherited

Methods

getAuthorizationHeader({required String clientId, String? clientSecret}) → Map<String, String>
inherited
getAuthorizeUrl({required String clientId, String responseType = 'code', String? redirectUri, List<String>? scopes, bool enableState = true, String? state, String? codeChallenge, Map<String, dynamic>? customParams}) → String
Generates the url to be used for fetching the authorization code.
inherited
getRefreshUrlParams({required String refreshToken}) → Map<String, String>
Returns the parameters needed for the refresh token request
inherited
getTokenUrlParams({required String code, String? redirectUri, String? codeVerifier, Map<String, dynamic>? customParams}) → Map<String, dynamic>
Returns the parameters needed for the authorization code request
inherited
getTokenWithAuthCodeFlow({required String clientId, List<String>? scopes, String? clientSecret, bool enablePKCE = true, bool enableState = true, String? state, String? codeVerifier, Function? afterAuthorizationCodeCb, Map<String, dynamic>? authCodeParams, Map<String, dynamic>? accessTokenParams, Map<String, String>? accessTokenHeaders, dynamic httpClient, BaseWebAuth? webAuthClient, Map<String, dynamic>? webAuthOpts}) → Future<AccessTokenResponse>
Requests an Access Token to the OAuth2 endpoint using the Authorization Code Flow.
override
getTokenWithClientCredentialsFlow({required String clientId, required String clientSecret, List<String>? scopes, Map<String, String>? customHeaders, dynamic httpClient}) → Future<AccessTokenResponse>
Requests an Access Token to the OAuth2 endpoint using the Client Credentials flow.
inherited
getTokenWithImplicitGrantFlow({required String clientId, List<String>? scopes, bool enableState = true, String? state, dynamic httpClient, BaseWebAuth? webAuthClient, Map<String, dynamic>? webAuthOpts, Map<String, dynamic>? customParams}) → Future<AccessTokenResponse>
Requests an Access Token to the OAuth2 endpoint using the Implicit grant flow (https://tools.ietf.org/html/rfc6749#page-31)
inherited
http2TokenResponse(Response response, {List<String>? requestedScopes}) → AccessTokenResponse
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refreshToken(String refreshToken, {dynamic httpClient, required String clientId, String? clientSecret, List<String>? scopes}) → Future<AccessTokenResponse>
Refreshes an Access Token issuing a refresh_token grant to the OAuth2 server.
inherited
requestAccessToken({required String code, required String clientId, String? clientSecret, String? codeVerifier, List<String>? scopes, Map<String, dynamic>? customParams, Map<String, String>? customHeaders, dynamic httpClient}) → Future<AccessTokenResponse>
Requests and Access Token using the provided Authorization code.
inherited
requestAuthorization({required String clientId, List<String>? scopes, String? codeChallenge, bool enableState = true, String? state, Map<String, dynamic>? customParams, BaseWebAuth? webAuthClient, Map<String, dynamic>? webAuthOpts}) → Future<AuthorizationResponse>
Requests an Authorization Code to be used in the Authorization Code grant.
inherited
revokeAccessToken(AccessTokenResponse tknResp, {String? clientId, String? clientSecret, dynamic httpClient}) → Future<OAuth2Response>
Revokes the Access Token in the provided tknResp
inherited
revokeRefreshToken(AccessTokenResponse tknResp, {String? clientId, String? clientSecret, dynamic httpClient}) → Future<OAuth2Response>
Revokes the Refresh Token in the provided tknResp
inherited
revokeToken(AccessTokenResponse tknResp, {String? clientId, String? clientSecret, dynamic httpClient}) → Future<OAuth2Response>
Revokes both the Access and the Refresh tokens in the provided tknResp
inherited
serializeScopes(List<String> scopes) → String
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited