Configuration Overview

Understanding how IdentitySuite stores and manages configuration settings

Property Tooltips

Many configuration properties include an informational icon that provides additional context. Hovering over the icon reveals a tooltip containing a detailed explanation of the property, its default value, and—when applicable—its impact on the system’s behavior.

What You Will Find in Tooltips:

  • A clear description of the property’s purpose
  • The default value applied when no configuration is provided
  • Behavioral implications and interactions with related settings
  • Notes on prerequisites or dependencies when relevant

Important Notice

Tooltip descriptions are generated using AI assistance. While they are designed to be accurate and helpful, they may occasionally contain incomplete or incorrect information. Always validate critical configuration details using the official documentation or by reviewing the underlying system behavior.

Configuration File Management

IdentitySuite automatically manages configuration settings through environment-specific JSON files. When you modify settings through the web interface, these changes are saved to the appropriate configuration file based on your current running environment.

Configuration File Structure:

File Location: All configuration files are stored in the IdentitySuite folder located in the root directory of your project or publication folder.
Naming Convention: Files follow the pattern IdentitySuite.[Environment].json where [Environment] corresponds to your application's current running environment.
Environment-Specific Loading: IdentitySuite automatically loads the configuration file matching your current environment, ensuring settings are applied correctly for each deployment scenario.

Default Environment Files:

IdentitySuite.Development.json
- Development environment settings
IdentitySuite.Production.json
- Production environment settings
IdentitySuite.Staging.json
- Staging environment settings

Custom Environments:

Flexible Configuration: You can create additional environment-specific configuration files for custom deployment scenarios such as testing, integration, or client-specific environments.
Custom Naming: Create a new file following the naming pattern IdentitySuite.[YourEnvironmentName].json and IdentitySuite will automatically recognize and use it when running in that environment.
💡

Automatic Synchronization:

Changes made through the IdentitySuite web interface are written to the appropriate configuration file only after you click the Save button. It's important to note that you must restart the application for the changes to take effect, as some settings are read and applied during application startup.

Sensitive Data Encryption

IdentitySuite provides built-in encryption capabilities for sensitive configuration data such as API keys, client secrets, and connection strings. This feature helps protect confidential information stored in configuration files from casual exposure.

How Encryption Works:

Encryption Toggle: Sensitive configuration fields display an eye icon with a slash (). Clicking this button encrypts the field value and changes the icon to a regular eye ().
View Decrypted Content: When a field is encrypted, clicking the eye icon () temporarily displays the decrypted content, allowing you to verify or modify the value.
Automatic Processing: IdentitySuite automatically detects and decrypts encrypted values when loading configuration files, making the process transparent to the application.

Encryption States:

Unencrypted
→ Field content is visible and stored in plain text
Encrypted
→ Field content is encrypted and stored securely

Security Considerations:

  • Protection Level: This encryption provides protection against casual access to configuration files
  • Certificate Storage: Encryption certificates are stored within the project directory
  • Intended Use: Designed as a deterrent for shared or less secure deployment environments
  • Not Absolute Security: This feature does not provide complete security against determined attackers with server access

Best Practices:

Development: Consider leaving values unencrypted for easier debugging and development
Shared Environments: Enable encryption for sensitive values in staging or shared development servers
Production: Encrypt all sensitive configuration data before deployment to production environments
Additional Security: Combine with proper file system permissions and secure deployment practices

Configuration Workflow

Understanding the configuration workflow helps ensure smooth deployment and maintenance of your IdentitySuite installation across different environments.

Configuration Process:

1
Modify Settings: Use the IdentitySuite web interface to configure authentication, CORS, login providers, and other system settings.
2
Automatic Save: Changes are immediately written to the appropriate environment-specific JSON configuration file in the IdentitySuite folder.
3
Encryption Processing: If encryption is enabled for sensitive fields, values are automatically encrypted before being stored in the configuration file.
4
Runtime Loading: During application startup, IdentitySuite loads the appropriate configuration file and automatically decrypts any encrypted values.

Benefits of This Approach:

  • • Environment-specific configurations ensure proper settings for each deployment
  • • Automatic file management eliminates manual configuration file editing
  • • Built-in encryption provides protection for sensitive data
  • • Transparent decryption process requires no additional configuration
  • • Easy backup and version control of configuration settings