SettingName.cs

// Copyright © Datalust and contributors. 
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System;
using Seq.Api.Model.Apps;
using Seq.Api.Model.Updates;
using Seq.Api.Model.Users;
using Seq.Api.ResourceGroups;

namespace Seq.Api.Model.Settings
{
    /// <summary>
    /// Runtime-modifiable setting names. See also <see cref="SettingEntity"/> and
    /// <see cref="SettingsResourceGroup"/>.
    /// </summary>
    public enum SettingName
    {
        /// <summary>
        /// The authentication provider to use. Allowed values are <c>null</c> (local username/password),
        /// <c>"Active Directory"</c>, <c>"Microsoft Entra ID"</c> and <c>"OpenID Connect"</c>.
        /// </summary>
        AuthenticationProvider,
        
        /// <summary>
        /// The name of an Active Directory group within which users will be automatically
        /// be granted user access to Seq.
        /// </summary>
        AutomaticAccessADGroup,

        /// <summary>
        /// If <c>true</c>, Microsoft Entra ID accounts in the configured tenant will
        /// be automatically granted user access to Seq.
        /// </summary>
        [Obsolete("Use `AutomaticallyProvisionAuthenticatedUsers`.", error: true)]
        AutomaticallyGrantUserAccessToADAccounts,
        
        /// <summary>
        /// If <c>true</c>, users authenticated with the configured authentication provider
        /// be automatically granted default user access to Seq.
        /// </summary>
        AutomaticallyProvisionAuthenticatedUsers,

        /// <summary>
        /// The Microsoft Entra ID authority. The default is <c>login.windows.net</c>; government cloud users may
        /// require <c>login.microsoftonline.us</c> or similar.
        /// </summary>
        // ReSharper disable once InconsistentNaming
        EntraIDAuthority,
        
        /// <summary>
        /// The Microsoft Entra ID client id.
        /// </summary>
        // ReSharper disable once InconsistentNaming
        EntraIDClientId,

        /// <summary>
        /// The Microsoft Entra ID client key.
        /// </summary>
        // ReSharper disable once InconsistentNaming
        EntraIDClientKey,

        /// <summary>
        /// The Microsoft Entra ID tenant id.
        /// </summary>
        // ReSharper disable once InconsistentNaming
        EntraIDTenantId,

        /// <summary>
        /// Server-local filesystem location where automatic backups are stored.
        /// </summary>
        BackupLocation,

        /// <summary>
        /// The number of backups to keep.
        /// </summary>
        BackupsToKeep,

        /// <summary>
        /// The UTC time of day to record new backups.
        /// </summary>
        BackupUtcTimeOfDay,

        /// <summary>
        /// If <c>true</c>, Seq will periodically check configured NuGet feed for
        /// updated versions of installed app packages, and
        /// set <see cref="AppPackagePart.UpdateAvailable"/> accordingly.
        /// </summary>
        CheckForPackageUpdates,

        /// <summary>
        /// If <c>true</c>, Seq will periodically check for new Seq versions, and
        /// create an <see cref="AvailableUpdateEntity"/> accordingly.
        /// </summary>
        CheckForUpdates,

        /// <summary>
        /// A friendly, public, human-readable title identifying this particular Seq instance.
        /// </summary>
        InstanceTitle,

        /// <summary>
        /// If <c>true</c>, the server supports Active Directory authentication.
        /// </summary>
        [Obsolete("Set `AuthenticationProvider` to \"Active Directory\" to enable.", error: true)]
        IsActiveDirectoryAuthentication,

        /// <summary>
        /// If <c>true</c>, the server has authentication enabled.
        /// </summary>
        IsAuthenticationEnabled,

        /// <summary>
        /// The minimum storage space, in bytes, on the disk containing log events, before
        /// Seq will stop accepting new events.
        /// </summary>
        MinimumFreeStorageSpace,
        
        /// <summary>
        /// A dictionary of `(string, string)` pairs that will be used to initialize the
        /// <see cref="UserEntity.Preferences"/> property when preparing new user entities
        /// with <see cref="UsersResourceGroup.TemplateAsync"/>, and with automatically
        /// provisioning SSO users (when enabled).
        /// </summary>
        /// <remarks>User preference keys are unconstrained; the Seq UI uses a number of these, but
        /// alternative interfaces and integrations may add additional items to this collection.</remarks>
        NewUserPreferences,

        /// <summary>
        /// A comma-separated list of role ids that will be assigned to new users by default.
        /// </summary>
        NewUserRoleIds,

        /// <summary>
        /// A comma-separated list of (shared) signal ids that will be included in any new user's
        /// personal default workspace.
        /// </summary>
        NewUserShowSignalIds,

        /// <summary>
        /// A comma-separated list of (shared) SQL query ids that will be included in any new user's
        /// personal default workspace.
        /// </summary>
        NewUserShowQueryIds,

        /// <summary>
        /// A comma-separated list of (shared) dashboard ids that will be included in any new user's
        /// personal default workspace.
        /// </summary>
        NewUserShowDashboardIds,

        /// <summary>
        /// If using OpenID Connect authentication, the URL of the authorization endpoint. For example,
        /// <c>https://example.com</c>.
        /// </summary>
        OpenIdConnectAuthority,
        
        /// <summary>
        /// If using OpenID Connect, the client id assigned to Seq in the provider.
        /// </summary>
        OpenIdConnectClientId,
        
        /// <summary>
        /// If using OpenID Connect, the client secret assigned to Seq in the provider.
        /// </summary>
        OpenIdConnectClientSecret,

        /// <summary>
        /// If using OpenID Connect, the scopes Seq will request when authorizing the client, as a comma-separated
        /// list. For example, <c>openid, profile, email</c>.
        /// </summary>
        OpenIdConnectScopes,
        
        /// <summary>
        /// If using OpenID Connect, overrides the URI of the provider's metadata endpoint.
        /// </summary>
        OpenIdConnectMetadataAddress,
    
        /// <summary>
        /// If <c>true</c>, ingestion requests incoming via HTTP must be authenticated using an API key or
        /// logged-in user session. Only effective when <see cref="IsAuthenticationEnabled"/> is <c>true</c>.
        /// </summary>
        RequireApiKeyForWritingEvents,

        /// <summary>
        /// The maximum size, in bytes of UTF-8-encoded JSON, beyond which individual events will be rejected.
        /// </summary>
        RawEventMaximumContentLength,

        /// <summary>
        /// The maximum size, in HTTP request content bytes, beyond which ingestion requests will be rejected.
        /// </summary>
        RawPayloadMaximumContentLength,
        
        /// <summary>
        /// Tracks whether an admin user has dismissed the secret key backup warning.
        /// </summary>
        SecretKeyIsBackedUp,
        
        /// <summary>
        /// A snippet of CSS that will be included in the front-end's user interface styles.
        /// </summary>
        ThemeStyles
    }
}