master
96d52884e8
Some checks failed
Docs CI / lint-and-preview (push) Has been cancelled
- Implemented PolicyDslValidator with command-line options for strict mode and JSON output. - Created PolicySchemaExporter to generate JSON schemas for policy-related models. - Developed PolicySimulationSmoke tool to validate policy simulations against expected outcomes. - Added project files and necessary dependencies for each tool. - Ensured proper error handling and usage instructions across tools.
234 lines
11 KiB
XML
234 lines
11 KiB
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.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.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.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="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.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="M:StellaOps.Auth.Client.StellaOpsTokenResult.ToCacheEntry">
|
|
<summary>
|
|
Converts the result to a cache entry.
|
|
</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|