GPAL - Generally Positive Automation Library v1.0
GPAL The Fluent Automation LIbrary
Loading...
Searching...
No Matches
GenerallyPositive.CredentialsConfig Class Reference

Endpoint URLs, redirect URIs, and protocol field names used by the credential service handlers.
Holds protocol/endpoint configuration only - never secrets. Loaded from and saved to ./credentialsConfig.json via Load()/Save(). More...

Static Public Member Functions

static CredentialsConfig Load (GPALFile file=null)
 Loads the credentials config, falling back to defaults if the file is missing or invalid. If file is provided it becomes the new default path for this session.
static void Save (GPALFile file=null)
 Saves the default credentials configuration to the config file as a starter file for editing. If file is provided it becomes the new default path for this session.

Properties

bool UseRestRedirect = true [get, set]
 When true, the OAuth authorization code is retrieved by polling GPALRESTAPI's get-access-token endpoint after the redirect; when false, the user is prompted to paste the auth code manually.
string GoogleConsentBase = "https://accounts.google.com" [get, set]
 Base URL for Google's OAuth consent/authorization page.
string GoogleAuthBase = "https://oauth2.googleapis.com" [get, set]
 Base URL for Google's OAuth token endpoint.
string GoogleAuthEndpoint = "/token" [get, set]
 Path of Google's OAuth token endpoint, appended to GoogleAuthBase.
string GoogleRedirectUri = "urn:ietf:wg:oauth:2.0:oob" [get, set]
 Redirect URI used for the manual (out-of-band) Google OAuth flow.
string GoogleRestRedirectUri = "http://localhost:3000/access-token" [get, set]
 Redirect URI used when UseRestRedirect is true; GPALRESTAPI listens here for the OAuth callback.
string GoogleAuthCodeKey = "code" [get, set]
 Query string key under which Google returns the authorization code.
string GoogleServiceAccountTokenUri = "https://oauth2.googleapis.com/token" [get, set]
 Token endpoint used when exchanging a Google service-account JWT for an access token.
string AzureAuthBase = "https://login.microsoftonline.com/common" [get, set]
 Base URL for the Azure AD (Microsoft Entra ID) OAuth token endpoint.
string AzureAuthEndpoint = "/oauth2/v2.0/token" [get, set]
 Path of the Azure AD OAuth token endpoint, appended to AzureAuthBase.
string AzureRedirectUri = "urn:ietf:wg:oauth:2.0:oob" [get, set]
 Redirect URI used for the manual (out-of-band) Azure OAuth flow.
string AWSAuthBase = "https://your-domain.auth.{region}.amazoncognito.com" [get, set]
 Base URL of your AWS Cognito hosted UI domain. Must be replaced with your actual Cognito domain.
string AWSAuthEndpoint = "/oauth2/token" [get, set]
 Path of the AWS Cognito OAuth token endpoint, appended to AWSAuthBase.
string AWSRedirectUri = "urn:ietf:wg:oauth:2.0:oob" [get, set]
 Redirect URI used for the manual (out-of-band) AWS Cognito OAuth flow.
string BitwardenAuthBase = "https://identity.bitwarden.com" [get, set]
 Base URL for the Bitwarden identity (token) service.
string BitwardenVaultBase = "https://api.bitwarden.com" [get, set]
 Base URL for the Bitwarden public vault API.
string BitwardenAuthEndpoint = "/connect/token" [get, set]
 Path of the Bitwarden OAuth token endpoint, appended to BitwardenAuthBase.
string BitwardenVaultEndpoint = "/public/vault/items" [get, set]
 Path of the Bitwarden vault items endpoint, appended to BitwardenVaultBase.
string AuthorizationHeader = "Authorization" [get, set]
 HTTP header name used to send the bearer access token.
string GrantTypeKey = "grant_type" [get, set]
 Form field key for the OAuth grant_type parameter.
string GrantTypeValue = "password" [get, set]
 Default OAuth grant_type value (resource owner password credentials).
string UsernameKey = "username" [get, set]
 Form field key for the username parameter.
string PasswordKey = "password" [get, set]
 Form field key for the password parameter.
string ClientIdKey = "client_id" [get, set]
 Form field key for the OAuth client_id parameter.
string ClientSecretKey = "client_secret" [get, set]
 Form field key for the OAuth client_secret parameter.
string SearchKey = "search" [get, set]
 Query parameter key used when searching a vault for an item.
string AccessTokenKey = "access_token" [get, set]
 JSON field key under which an OAuth token response returns the access token.

Detailed Description

Endpoint URLs, redirect URIs, and protocol field names used by the credential service handlers.
Holds protocol/endpoint configuration only - never secrets. Loaded from and saved to ./credentialsConfig.json via Load()/Save().

Definition at line 46 of file Credentials.cs.

Member Function Documentation

◆ Load()

CredentialsConfig GenerallyPositive.CredentialsConfig.Load ( GPALFile file = null)
static

Loads the credentials config, falling back to defaults if the file is missing or invalid. If file is provided it becomes the new default path for this session.

Definition at line 173 of file Credentials.cs.

◆ Save()

void GenerallyPositive.CredentialsConfig.Save ( GPALFile file = null)
static

Saves the default credentials configuration to the config file as a starter file for editing. If file is provided it becomes the new default path for this session.

Definition at line 201 of file Credentials.cs.

Property Documentation

◆ AccessTokenKey

string GenerallyPositive.CredentialsConfig.AccessTokenKey = "access_token"
getset

JSON field key under which an OAuth token response returns the access token.

Definition at line 167 of file Credentials.cs.

◆ AuthorizationHeader

string GenerallyPositive.CredentialsConfig.AuthorizationHeader = "Authorization"
getset

HTTP header name used to send the bearer access token.

Definition at line 135 of file Credentials.cs.

◆ AWSAuthBase

string GenerallyPositive.CredentialsConfig.AWSAuthBase = "https://your-domain.auth.{region}.amazoncognito.com"
getset

Base URL of your AWS Cognito hosted UI domain. Must be replaced with your actual Cognito domain.

Definition at line 103 of file Credentials.cs.

◆ AWSAuthEndpoint

string GenerallyPositive.CredentialsConfig.AWSAuthEndpoint = "/oauth2/token"
getset

Path of the AWS Cognito OAuth token endpoint, appended to AWSAuthBase.

Definition at line 107 of file Credentials.cs.

◆ AWSRedirectUri

string GenerallyPositive.CredentialsConfig.AWSRedirectUri = "urn:ietf:wg:oauth:2.0:oob"
getset

Redirect URI used for the manual (out-of-band) AWS Cognito OAuth flow.

Definition at line 111 of file Credentials.cs.

◆ AzureAuthBase

string GenerallyPositive.CredentialsConfig.AzureAuthBase = "https://login.microsoftonline.com/common"
getset

Base URL for the Azure AD (Microsoft Entra ID) OAuth token endpoint.

Definition at line 89 of file Credentials.cs.

◆ AzureAuthEndpoint

string GenerallyPositive.CredentialsConfig.AzureAuthEndpoint = "/oauth2/v2.0/token"
getset

Path of the Azure AD OAuth token endpoint, appended to AzureAuthBase.

Definition at line 93 of file Credentials.cs.

◆ AzureRedirectUri

string GenerallyPositive.CredentialsConfig.AzureRedirectUri = "urn:ietf:wg:oauth:2.0:oob"
getset

Redirect URI used for the manual (out-of-band) Azure OAuth flow.

Definition at line 97 of file Credentials.cs.

◆ BitwardenAuthBase

string GenerallyPositive.CredentialsConfig.BitwardenAuthBase = "https://identity.bitwarden.com"
getset

Base URL for the Bitwarden identity (token) service.

Definition at line 117 of file Credentials.cs.

◆ BitwardenAuthEndpoint

string GenerallyPositive.CredentialsConfig.BitwardenAuthEndpoint = "/connect/token"
getset

Path of the Bitwarden OAuth token endpoint, appended to BitwardenAuthBase.

Definition at line 125 of file Credentials.cs.

◆ BitwardenVaultBase

string GenerallyPositive.CredentialsConfig.BitwardenVaultBase = "https://api.bitwarden.com"
getset

Base URL for the Bitwarden public vault API.

Definition at line 121 of file Credentials.cs.

◆ BitwardenVaultEndpoint

string GenerallyPositive.CredentialsConfig.BitwardenVaultEndpoint = "/public/vault/items"
getset

Path of the Bitwarden vault items endpoint, appended to BitwardenVaultBase.

Definition at line 129 of file Credentials.cs.

◆ ClientIdKey

string GenerallyPositive.CredentialsConfig.ClientIdKey = "client_id"
getset

Form field key for the OAuth client_id parameter.

Definition at line 155 of file Credentials.cs.

◆ ClientSecretKey

string GenerallyPositive.CredentialsConfig.ClientSecretKey = "client_secret"
getset

Form field key for the OAuth client_secret parameter.

Definition at line 159 of file Credentials.cs.

◆ GoogleAuthBase

string GenerallyPositive.CredentialsConfig.GoogleAuthBase = "https://oauth2.googleapis.com"
getset

Base URL for Google's OAuth token endpoint.

Definition at line 63 of file Credentials.cs.

◆ GoogleAuthCodeKey

string GenerallyPositive.CredentialsConfig.GoogleAuthCodeKey = "code"
getset

Query string key under which Google returns the authorization code.

Definition at line 79 of file Credentials.cs.

◆ GoogleAuthEndpoint

string GenerallyPositive.CredentialsConfig.GoogleAuthEndpoint = "/token"
getset

Path of Google's OAuth token endpoint, appended to GoogleAuthBase.

Definition at line 67 of file Credentials.cs.

◆ GoogleConsentBase

string GenerallyPositive.CredentialsConfig.GoogleConsentBase = "https://accounts.google.com"
getset

Base URL for Google's OAuth consent/authorization page.

Definition at line 59 of file Credentials.cs.

◆ GoogleRedirectUri

string GenerallyPositive.CredentialsConfig.GoogleRedirectUri = "urn:ietf:wg:oauth:2.0:oob"
getset

Redirect URI used for the manual (out-of-band) Google OAuth flow.

Definition at line 71 of file Credentials.cs.

◆ GoogleRestRedirectUri

string GenerallyPositive.CredentialsConfig.GoogleRestRedirectUri = "http://localhost:3000/access-token"
getset

Redirect URI used when UseRestRedirect is true; GPALRESTAPI listens here for the OAuth callback.

Definition at line 75 of file Credentials.cs.

◆ GoogleServiceAccountTokenUri

string GenerallyPositive.CredentialsConfig.GoogleServiceAccountTokenUri = "https://oauth2.googleapis.com/token"
getset

Token endpoint used when exchanging a Google service-account JWT for an access token.

Definition at line 83 of file Credentials.cs.

◆ GrantTypeKey

string GenerallyPositive.CredentialsConfig.GrantTypeKey = "grant_type"
getset

Form field key for the OAuth grant_type parameter.

Definition at line 139 of file Credentials.cs.

◆ GrantTypeValue

string GenerallyPositive.CredentialsConfig.GrantTypeValue = "password"
getset

Default OAuth grant_type value (resource owner password credentials).

Definition at line 143 of file Credentials.cs.

◆ PasswordKey

string GenerallyPositive.CredentialsConfig.PasswordKey = "password"
getset

Form field key for the password parameter.

Definition at line 151 of file Credentials.cs.

◆ SearchKey

string GenerallyPositive.CredentialsConfig.SearchKey = "search"
getset

Query parameter key used when searching a vault for an item.

Definition at line 163 of file Credentials.cs.

◆ UseRestRedirect

bool GenerallyPositive.CredentialsConfig.UseRestRedirect = true
getset

When true, the OAuth authorization code is retrieved by polling GPALRESTAPI's get-access-token endpoint after the redirect; when false, the user is prompted to paste the auth code manually.

Definition at line 53 of file Credentials.cs.

◆ UsernameKey

string GenerallyPositive.CredentialsConfig.UsernameKey = "username"
getset

Form field key for the username parameter.

Definition at line 147 of file Credentials.cs.

The documentation for this class was generated from the following file: