Skip to main content

Auth reference

Interfaces

TypeSummary
ICredentialProviderProvides authenticated ServiceClient instances for a specific auth method.
IGlobalDiscoveryServiceService for discovering Dataverse environments via the Global Discovery Service.
IPowerPlatformTokenProviderProvides access tokens for Power Platform REST APIs (Power Apps, Power Automate, etc.).
ISecureCredentialStoreProvides secure, platform-native credential storage for service principal secrets.

Classes

TypeSummary
AmbiguousMatchExceptionException thrown when multiple environments match a given identifier.
AuthDebugLogControls debug logging output for the auth library.
AuthProfileAn authentication profile containing credentials and environment binding.
AuthenticationExceptionException thrown when authentication fails.
AuthenticationOutputControls authentication status output for the auth library.
AzureDevOpsFederatedCredentialProviderProvides authentication using Azure DevOps OIDC (workload identity federation).
CertificateFileCredentialProviderProvides authentication using a certificate file (PFX/P12).
CertificateStoreCredentialProviderProvides authentication using a certificate from the Windows certificate store.
ClientSecretCredentialProviderProvides authentication using client ID and client secret (Service Principal).
CloudEndpointsProvides endpoint URLs for different Azure cloud environments.
ConnectionResolverResolves profile names to authenticated connections.
CredentialProviderFactoryFactory for creating credential providers from auth profiles.
CredentialResultResult of creating a credential provider.
DeviceCodeCredentialProviderProvides authentication using device code flow.
DeviceCodeInfoInformation about a device code for authentication.
DiscoveredEnvironmentRepresents an environment discovered via the Global Discovery Service.
EnvironmentConfigUser configuration for a specific Dataverse environment.
EnvironmentConfigCollectionRoot object for environments.json — holds per-environment configs and custom type defaults.
EnvironmentConfigStoreManages persistent storage of environment configurations.
EnvironmentInfoInformation about a Dataverse environment bound to a profile.
EnvironmentResolutionResultResult of an environment resolution attempt.
EnvironmentResolutionServiceService for resolving environments using a multi-layer strategy.
EnvironmentResolverResolves an environment from a collection by various criteria.
EnvironmentVariableAuthReads authentication configuration from environment variables for CI/CD scenarios.
GitHubFederatedCredentialProviderProvides authentication using GitHub Actions OIDC (workload identity federation).
GlobalDiscoveryServiceService for discovering Dataverse environments via the Global Discovery Service.
InteractiveBrowserCredentialProviderProvides authentication using interactive browser flow.
ManagedIdentityCredentialProviderProvides authentication using Azure Managed Identity.
NativeCredentialStoreProvides secure, platform-native credential storage using OS credential managers.
PowerPlatformTokenRepresents an access token for Power Platform APIs.
PowerPlatformTokenProviderProvides access tokens for Power Platform REST APIs using MSAL.
ProfileCollectionCollection of authentication profiles with active profile tracking.
ProfileConnectionSourceConnection source that creates ServiceClients from an authentication profile.
ProfileEncryptionProvides platform-specific encryption for sensitive profile data.
ProfilePathsProvides platform-specific paths for profile storage.
ProfileResolverResolves which profile to use based on the priority order:
ProfileStoreManages persistent storage of authentication profiles.
QuerySafetySettingsPer-environment query safety settings. Stored in environment config JSON.
ServiceClientFactoryFactory for creating authenticated ServiceClient instances from profiles.
ServiceCollectionExtensionsExtension methods for registering PPDS Auth services with dependency injection.
StoredCredentialRepresents a credential stored in secure platform storage.
TokenCacheDetectorUtility to detect the token cache type for the current platform.
TokenCacheManagerManages token cache operations including clearing cached credentials.
UsernamePasswordCredentialProviderProvides authentication using username and password (ROPC flow).

Records

TypeSummary
CachedTokenInfoInformation about a cached token, retrieved without triggering authentication.

Enums

TypeSummary
AuthMethodAuthentication method for a profile.
BypassPluginModeWhich plugin types to bypass during DML operations.
CloudEnvironmentAzure cloud environments for Dataverse authentication.
CrossEnvironmentDmlPolicyCross-environment DML policy.
DateTimeModeDateTime display mode for query results.
EnvironmentColorNamed colors for environment theming.
EnvironmentTypeClassification of Dataverse environment types.
PreAuthDialogResultResult of the pre-authentication dialog shown before browser auth.
ProtectionLevelEnvironment protection level determining DML behavior.
ResolutionMethodMethod used to resolve an environment.
TokenCacheTypeToken cache storage type.