git.stella-ops.org/publish-platform/StellaOps.Auth.Client.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>StellaOps.Auth.Client</name>
    </assembly>
    <members>
        <member name="T:StellaOps.Auth.Client.FileTokenCache">
            <summary>
            File-based token cache suitable for CLI/offline usage.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.InMemoryTokenCache">
            <summary>
            In-memory token cache suitable for service scenarios.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.IStellaOpsTokenCache">
            <summary>
            Abstraction for caching StellaOps tokens.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenCache.GetAsync(System.String,System.Threading.CancellationToken)">
            <summary>
            Retrieves a cached token entry, if present.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenCache.SetAsync(System.String,StellaOps.Auth.Client.StellaOpsTokenCacheEntry,System.Threading.CancellationToken)">
            <summary>
            Stores or updates a token entry for the specified key.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenCache.RemoveAsync(System.String,System.Threading.CancellationToken)">
            <summary>
            Removes the cached entry for the specified key.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.IStellaOpsTokenClient">
            <summary>
            Abstraction for requesting tokens from StellaOps Authority.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.RequestPasswordTokenAsync(System.String,System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)">
            <summary>
            Requests an access token using the resource owner password credentials flow.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.RequestClientCredentialsTokenAsync(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)">
            <summary>
            Requests an access token using the client credentials flow.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.GetJsonWebKeySetAsync(System.Threading.CancellationToken)">
            <summary>
            Retrieves the cached JWKS document.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.GetCachedTokenAsync(System.String,System.Threading.CancellationToken)">
            <summary>
            Retrieves a cached token entry.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.CacheTokenAsync(System.String,StellaOps.Auth.Client.StellaOpsTokenCacheEntry,System.Threading.CancellationToken)">
            <summary>
            Persists a token entry in the cache.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.IStellaOpsTokenClient.ClearCachedTokenAsync(System.String,System.Threading.CancellationToken)">
            <summary>
            Removes a cached entry.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.MessagingTokenCache">
            <summary>
            Token cache backed by <see cref="T:StellaOps.Messaging.Abstractions.IDistributedCache`1"/>.
            Supports any transport (InMemory, Valkey, PostgreSQL) via factory injection.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.ServiceCollectionExtensions">
            <summary>
            DI helpers for the StellaOps auth client.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.ServiceCollectionExtensions.AddStellaOpsAuthClient(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{StellaOps.Auth.Client.StellaOpsAuthClientOptions})">
            <summary>
            Registers the StellaOps auth client with the provided configuration.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.ServiceCollectionExtensions.AddStellaOpsFileTokenCache(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String)">
            <summary>
            Registers a file-backed token cache implementation.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.ServiceCollectionExtensions.AddStellaOpsApiAuthentication(Microsoft.Extensions.DependencyInjection.IHttpClientBuilder,System.Action{StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions})">
            <summary>
            Adds authentication and tenancy header handling for an <see cref="T:System.Net.Http.HttpClient"/> registered via <see cref="T:Microsoft.Extensions.DependencyInjection.IHttpClientBuilder"/>.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions">
            <summary>
            Options controlling how <see cref="T:System.Net.Http.HttpClient"/> instances obtain authentication and tenancy headers.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Mode">
            <summary>
            Gets or sets the authentication mode used to authorise outbound requests.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Scope">
            <summary>
            Optional scope override supplied when requesting OAuth access tokens.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Username">
            <summary>
            Username used when <see cref="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Mode"/> is <see cref="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.Password"/>.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Password">
            <summary>
            Password used when <see cref="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Mode"/> is <see cref="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.Password"/>.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.PersonalAccessToken">
            <summary>
            Pre-issued personal access token used when <see cref="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Mode"/> is <see cref="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.PersonalAccessToken"/>.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.Tenant">
            <summary>
            Optional tenant identifier injected via <see cref="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.TenantHeader"/>. If <c>null</c>, the header is omitted.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.TenantHeader">
            <summary>
            Header name used to convey the tenant override (defaults to <c>X-StellaOps-Tenant</c>).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsApiAuthenticationOptions.RefreshBuffer">
            <summary>
            Buffer window applied before token expiration that triggers proactive refresh (defaults to 30 seconds).
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsApiAuthMode">
            <summary>
            Authentication strategies supported by the StellaOps API client helpers.
            </summary>
        </member>
        <member name="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.ClientCredentials">
            <summary>
            Use the OAuth 2.0 client credentials grant to request access tokens.
            </summary>
        </member>
        <member name="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.Password">
            <summary>
            Use the resource owner password credentials grant to request access tokens.
            </summary>
        </member>
        <member name="F:StellaOps.Auth.Client.StellaOpsApiAuthMode.PersonalAccessToken">
            <summary>
            Use a pre-issued personal access token (PAT) as the bearer credential.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsAuthClientOptions">
            <summary>
            Options controlling the StellaOps authentication client.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.Authority">
            <summary>
            Authority (issuer) base URL.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.ClientId">
            <summary>
            OAuth client identifier (optional for password flow).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.ClientSecret">
            <summary>
            OAuth client secret (optional for public clients).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.DefaultScopes">
            <summary>
            Default scopes requested for flows that do not explicitly override them.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.RetryDelays">
            <summary>
            Retry delays applied by HTTP retry policy (empty uses defaults).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.EnableRetries">
            <summary>
            Gets or sets a value indicating whether HTTP retry policies are enabled.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.HttpTimeout">
            <summary>
            Timeout applied to discovery and token HTTP requests.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.DiscoveryCacheLifetime">
            <summary>
            Lifetime of cached discovery metadata.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.JwksCacheLifetime">
            <summary>
            Lifetime of cached JWKS metadata.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.ExpirationSkew">
            <summary>
            Buffer applied when determining cache expiration (default: 30 seconds).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.AllowOfflineCacheFallback">
            <summary>
            Gets or sets a value indicating whether cached discovery/JWKS responses may be served when the Authority is unreachable.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.OfflineCacheTolerance">
            <summary>
            Additional tolerance window during which stale cache entries remain valid if offline fallback is allowed.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.AuthorityUri">
            <summary>
            Parsed Authority URI (populated after validation).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.NormalizedScopes">
            <summary>
            Normalised scope list (populated after validation).
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsAuthClientOptions.NormalizedRetryDelays">
            <summary>
            Normalised retry delays (populated after validation).
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsAuthClientOptions.Validate">
            <summary>
            Validates required values and normalises scope entries.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsBearerTokenHandler">
            <summary>
            Delegating handler that attaches bearer credentials and tenant headers to outbound requests.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsDiscoveryCache">
            <summary>
            Caches Authority discovery metadata.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.OpenIdConfiguration">
            <summary>
            Minimal OpenID Connect configuration representation.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.OpenIdConfiguration.#ctor(System.Uri,System.Uri)">
            <summary>
            Minimal OpenID Connect configuration representation.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsJwksCache">
            <summary>
            Caches JWKS documents for Authority.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsTokenCacheEntry">
            <summary>
            Represents a cached token entry.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsTokenCacheEntry.#ctor(System.String,System.String,System.DateTimeOffset,System.Collections.Generic.IReadOnlyList{System.String},System.String,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
            <summary>
            Represents a cached token entry.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsTokenCacheEntry.IsExpired(System.TimeProvider,System.Nullable{System.TimeSpan})">
            <summary>
            Determines whether the token is expired given the provided <see cref="T:System.TimeProvider"/>.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsTokenCacheEntry.NormalizeScopes">
            <summary>
            Creates a copy with scopes normalised.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsTokenClient">
            <summary>
            Default implementation of <see cref="T:StellaOps.Auth.Client.IStellaOpsTokenClient"/>.
            </summary>
        </member>
        <member name="T:StellaOps.Auth.Client.StellaOpsTokenResult">
            <summary>
            Represents an issued token with metadata.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsTokenResult.#ctor(System.String,System.String,System.DateTimeOffset,System.Collections.Generic.IReadOnlyList{System.String},System.String,System.String,System.String)">
            <summary>
            Represents an issued token with metadata.
            </summary>
        </member>
        <member name="P:StellaOps.Auth.Client.StellaOpsTokenResult.ExpiresAt">
            <summary>
            Temporary shim for callers expecting the legacy <c>ExpiresAt</c> member.
            </summary>
        </member>
        <member name="M:StellaOps.Auth.Client.StellaOpsTokenResult.ToCacheEntry">
            <summary>
            Converts the result to a cache entry.
            </summary>
        </member>
    </members>
</doc>