Class IntrospectionOptions

Namespace

Cratis.Arc.Introspection

Assembly

Cratis.Arc.Core.dll

Controls exposure of the discovery endpoints: the command and query catalogs (/.cratis/commands and /.cratis/queries) and identity discovery (/.cratis/users, /.cratis/tenants and /.cratis/identity-details/schema).

public class IntrospectionOptions

Inheritance

object

IntrospectionOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

MethodCalls.CallGenericMethod<TOut, T>(T, Expression<Func<T, Func<TOut>>>, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1>(T, Expression<Func<T, Func<T1, TOut>>>, T1, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2>(T, Expression<Func<T, Func<T1, T2, TOut>>>, T1, T2, params Type[])

MethodCalls.CallGenericMethod<TOut, T, T1, T2, T3>(T, Expression<Func<T, Func<T1, T2, T3, TOut>>>, T1, T2, T3, params Type[])

ConverterExtensions.ConvertTo(object, Type)

ConceptExtensions.GetConceptValue(object)

ConceptExtensions.IsConcept(object)

JsonValueExtensions.ToJsonValue(object?)

ObservableExtensions.InvokeAndWrapWithSubject<TResult>(object, Func<CancellationToken, IObservable<TResult>>)

ObservableExtensions.InvokeAndWrapWithTransformSubject<TResult, TSource>(object, Func<CancellationToken, IObservable<TSource>>, Func<TSource, TResult>)

Constructors

IntrospectionOptions()

public IntrospectionOptions()

Properties

Enabled

Gets or sets whether both catalog endpoints are mapped. Defaults to true. Does not control identity discovery.

public bool Enabled { get; set; }

Property Value

bool

IdentityDiscovery

Gets or sets whether users, tenants and the identity details schema discovery endpoints are mapped. Defaults to true.

public bool IdentityDiscovery { get; set; }

Property Value

bool

Remarks

Set this and Enabled to false to remove every discovery endpoint without evaluating authentication enforcement. This does not affect /.cratis/me. Access settings apply only to mapped discovery endpoints; role configuration is still validated when discovery is disabled.

RequireAuthentication

Gets or sets whether callers of the discovery endpoints must be authenticated.

public bool RequireAuthentication { get; set; }

Property Value

bool

Remarks

When not set, the default, the endpoints are anonymous in Development and require an authenticated caller everywhere else. The getter returns false when unset, but only an explicit assignment overrides the environment default. Set it to false to expose them anonymously in every environment, or to true to require authentication in every environment, including Development.

When it is not set and the host has no way to authenticate callers, such as an ASP.NET Core host without a default authentication scheme, the discovery endpoints are not mapped outside Development. When it is true, the same host fails at startup instead.

Authentication enforcement applies only when Enabled or IdentityDiscovery is true. When both are false, access settings are unused, but role configuration is still validated.

Roles

Gets or sets comma-separated roles, any one of which grants access. Roles are trimmed; empty roles are rejected. Setting roles requires an authenticated caller in every environment, and cannot be combined with RequireAuthentication set to false.

public string? Roles { get; set; }

Property Value

string

TrustForwardedIdentityHeaders

Gets or sets whether the host trusts identity headers forwarded by a trusted ingress.

[Obsolete("Use ArcOptions.TrustForwardedIdentityHeaders (Cratis:Arc:TrustForwardedIdentityHeaders), which applies to every request. This setting turns it on and will be removed in a future major version.")]
public bool TrustForwardedIdentityHeaders { get; set; }

Property Value

bool

Remarks

Trust in forwarded identity headers is now a host-wide setting that applies to every request, not only to the catalogs. Setting this to true still turns on TrustForwardedIdentityHeaders.