Credentials

OAuth and Service Account

For Google, Azure, and AWS, FetchAccessToken exchanges a Google service account key or an OAuth client ID/secret (with WithScope) for an access token - opening a browser for one-time consent if no service account key or refresh token is supplied.

After WithService(Google/Azure/AWS).WithUsername(...).WithPassword(...), call WithServiceAccountKey(file) to authenticate as a Google service account (no browser interaction), or WithClientId/WithClientSecret plus WithScope(OAuthScope) to use the standard OAuth authorization-code flow. FetchAccessToken(out accessToken) performs the exchange: for a service account it signs a JWT directly; for OAuth it uses WithRefreshToken if supplied, otherwise it builds the provider's authorization URL and opens a browser for the user to grant consent, then exchanges the resulting code for an access token and refresh token.

TIP

The first OAuth FetchAccessToken call requires the user to grant consent in a browser. Save the resulting RefreshToken and pass it via WithRefreshToken on subsequent runs to skip the consent screen.

Examples

GPAL Fluent: High-level fluent C# API

//CredentialServiceType.Azure and .AWS follow the same shape using the Azure_* and AWS_* OAuthScope values. FetchAccessToken returns an empty string on failure and stores the result on the credentials object for reuse.

// Google service account - no browser interaction required GPAL.CredentialsFor(CredentialServiceType.Google) .WithUsername("you@example.com") .WithPassword("your-password") .WithServiceAccountKey(GPAL.FileFor("service-account.json")) .WithScope(OAuthScope.Google_Sheets) .FetchAccessToken(out string serviceAccountToken); // Google OAuth client id/secret - opens a browser for consent the first time GPAL.CredentialsFor(CredentialServiceType.Google) .WithUsername("you@example.com") .WithPassword("your-password") .WithClientId("client-id.apps.googleusercontent.com") .WithClientSecret("client-secret") .WithScope(OAuthScope.Google_Drive) .FetchAccessToken(out string oauthToken); // Reuse a saved refresh token to skip the consent screen GPAL.CredentialsFor(CredentialServiceType.Google) .WithUsername("you@example.com") .WithPassword("your-password") .WithClientId("client-id.apps.googleusercontent.com") .WithClientSecret("client-secret") .WithRefreshToken("refresh-token") .WithScope(OAuthScope.Google_Drive) .FetchAccessToken(out string refreshedToken);

Documentation Example

Documentation

Showing off some plain text in these paragraphs eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Other formats

Here you can find different accents and emphasis sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

This is a link and how it could look like bestlinkinthebeautifulworld. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Here's just some classic bold text adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam notBoldSecondbestlinkinthebeautifulworld illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at adipisicing elit libero vel voluptas? Expedita, adipisicing facere dolores voluptatem ad ab rem assumenda soluta!

Other cuple of colors in case we want to emphasize several ways adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam adipisicing elit illo nostrum corporis at voluptatem libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta!

Adding Images to the content

Lorem ipsum dolor sit amet consectetur adipisicing elit. Obcaecati, iste distinctio veritatis eligendi laboriosam illo nostrum corporis at libero vel voluptas? Expedita, facere dolores voluptatem ad ab rem assumenda soluta! Lorem ipsum dolor, sit amet consectetur adipisicing elit. Quod veniam, quam ad expedita laborum sed at voluptates culpa ipsam ut vel. Ullam temporibus a mollitia quod aliquam ratione exercitationem nesciunt.

Coding Blocks

Lorem ipsum dolor sit amet consectetur adipisicing elit. Repudiandae quas consequuntur illo numquam assumenda autem exercitationem distinctio perspiciatis in natus. Eius dicta similique ipsam ipsa minima, nemo quae enim tempore.

GPAL

.CallIfNotFound(GenericCallIfNotFound)

.WithPublishToConsole();

//System.Drawing.Rectangle windowSize = new System.Drawing.Rectangle(10, 10, 1500, 1024);

// NOTE: we have to set browser = before we execute any steps

// this is due to the 'GenericCallIfNotFound' which might throw an exception, and BankScraper will not have the browser set when it calls scraper.Close()

// until the complete fluent line gets executed (meaning every step, meaning browser is not set until everything else succeeds)

browser = GPAL.Browser

.WithBrowserType(Enums.BrowserType.Chrome)

.WithProfileDataDirectory(ChromeProfileLocation)

.WithUseAutomationEngine(AutomationEngine.Selenium)

.WithWindowSize(new System.Drawing.Rectangle(0,0,1920,1080))

.ToGPALObject();

Credentials

Credentials

OAuth and Service Account

Examples

Documentation Example

Documentation

Category

Endpoint

Enpoint

Enpoint

Enpoint

Other formats

Adding Images to the content

Coding Blocks

On this page