1. Packages
  2. Authentik Provider
  3. API Docs
  4. SystemSettings
authentik 2025.2.0 published on Monday, Mar 24, 2025 by goauthentik

authentik.SystemSettings

Explore with Pulumi AI

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as authentik from "@pulumi/authentik";

const settings = new authentik.SystemSettings("settings", {defaultUserChangeUsername: true});
Copy
import pulumi
import pulumi_authentik as authentik

settings = authentik.SystemSettings("settings", default_user_change_username=True)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/authentik/v2025/authentik"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := authentik.NewSystemSettings(ctx, "settings", &authentik.SystemSettingsArgs{
			DefaultUserChangeUsername: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Authentik = Pulumi.Authentik;

return await Deployment.RunAsync(() => 
{
    var settings = new Authentik.SystemSettings("settings", new()
    {
        DefaultUserChangeUsername = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.authentik.SystemSettings;
import com.pulumi.authentik.SystemSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var settings = new SystemSettings("settings", SystemSettingsArgs.builder()
            .defaultUserChangeUsername(true)
            .build());

    }
}
Copy
resources:
  settings:
    type: authentik:SystemSettings
    properties:
      defaultUserChangeUsername: true
Copy

Create SystemSettings Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SystemSettings(name: string, args?: SystemSettingsArgs, opts?: CustomResourceOptions);
@overload
def SystemSettings(resource_name: str,
                   args: Optional[SystemSettingsArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def SystemSettings(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   avatars: Optional[str] = None,
                   default_token_duration: Optional[str] = None,
                   default_token_length: Optional[float] = None,
                   default_user_change_email: Optional[bool] = None,
                   default_user_change_name: Optional[bool] = None,
                   default_user_change_username: Optional[bool] = None,
                   event_retention: Optional[str] = None,
                   footer_links: Optional[Sequence[Mapping[str, str]]] = None,
                   gdpr_compliance: Optional[bool] = None,
                   impersonation: Optional[bool] = None,
                   system_settings_id: Optional[str] = None)
func NewSystemSettings(ctx *Context, name string, args *SystemSettingsArgs, opts ...ResourceOption) (*SystemSettings, error)
public SystemSettings(string name, SystemSettingsArgs? args = null, CustomResourceOptions? opts = null)
public SystemSettings(String name, SystemSettingsArgs args)
public SystemSettings(String name, SystemSettingsArgs args, CustomResourceOptions options)
type: authentik:SystemSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args SystemSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args SystemSettingsArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args SystemSettingsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args SystemSettingsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SystemSettingsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var systemSettingsResource = new Authentik.SystemSettings("systemSettingsResource", new()
{
    Avatars = "string",
    DefaultTokenDuration = "string",
    DefaultTokenLength = 0,
    DefaultUserChangeEmail = false,
    DefaultUserChangeName = false,
    DefaultUserChangeUsername = false,
    EventRetention = "string",
    FooterLinks = new[]
    {
        
        {
            { "string", "string" },
        },
    },
    GdprCompliance = false,
    Impersonation = false,
    SystemSettingsId = "string",
});
Copy
example, err := authentik.NewSystemSettings(ctx, "systemSettingsResource", &authentik.SystemSettingsArgs{
	Avatars:                   pulumi.String("string"),
	DefaultTokenDuration:      pulumi.String("string"),
	DefaultTokenLength:        pulumi.Float64(0),
	DefaultUserChangeEmail:    pulumi.Bool(false),
	DefaultUserChangeName:     pulumi.Bool(false),
	DefaultUserChangeUsername: pulumi.Bool(false),
	EventRetention:            pulumi.String("string"),
	FooterLinks: pulumi.StringMapArray{
		pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	GdprCompliance:   pulumi.Bool(false),
	Impersonation:    pulumi.Bool(false),
	SystemSettingsId: pulumi.String("string"),
})
Copy
var systemSettingsResource = new SystemSettings("systemSettingsResource", SystemSettingsArgs.builder()
    .avatars("string")
    .defaultTokenDuration("string")
    .defaultTokenLength(0)
    .defaultUserChangeEmail(false)
    .defaultUserChangeName(false)
    .defaultUserChangeUsername(false)
    .eventRetention("string")
    .footerLinks(Map.of("string", "string"))
    .gdprCompliance(false)
    .impersonation(false)
    .systemSettingsId("string")
    .build());
Copy
system_settings_resource = authentik.SystemSettings("systemSettingsResource",
    avatars="string",
    default_token_duration="string",
    default_token_length=0,
    default_user_change_email=False,
    default_user_change_name=False,
    default_user_change_username=False,
    event_retention="string",
    footer_links=[{
        "string": "string",
    }],
    gdpr_compliance=False,
    impersonation=False,
    system_settings_id="string")
Copy
const systemSettingsResource = new authentik.SystemSettings("systemSettingsResource", {
    avatars: "string",
    defaultTokenDuration: "string",
    defaultTokenLength: 0,
    defaultUserChangeEmail: false,
    defaultUserChangeName: false,
    defaultUserChangeUsername: false,
    eventRetention: "string",
    footerLinks: [{
        string: "string",
    }],
    gdprCompliance: false,
    impersonation: false,
    systemSettingsId: "string",
});
Copy
type: authentik:SystemSettings
properties:
    avatars: string
    defaultTokenDuration: string
    defaultTokenLength: 0
    defaultUserChangeEmail: false
    defaultUserChangeName: false
    defaultUserChangeUsername: false
    eventRetention: string
    footerLinks:
        - string: string
    gdprCompliance: false
    impersonation: false
    systemSettingsId: string
Copy

SystemSettings Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SystemSettings resource accepts the following input properties:

Avatars string
Defaults to gravatar,initials.
DefaultTokenDuration string
Defaults to minutes=30.
DefaultTokenLength double
Defaults to 60.
DefaultUserChangeEmail bool
Defaults to false.
DefaultUserChangeName bool
Defaults to true.
DefaultUserChangeUsername bool
Defaults to false.
EventRetention string
Defaults to days=365.
FooterLinks List<ImmutableDictionary<string, string>>
GdprCompliance bool
Defaults to true.
Impersonation bool
Defaults to true.
SystemSettingsId string
The ID of this resource.
Avatars string
Defaults to gravatar,initials.
DefaultTokenDuration string
Defaults to minutes=30.
DefaultTokenLength float64
Defaults to 60.
DefaultUserChangeEmail bool
Defaults to false.
DefaultUserChangeName bool
Defaults to true.
DefaultUserChangeUsername bool
Defaults to false.
EventRetention string
Defaults to days=365.
FooterLinks []map[string]string
GdprCompliance bool
Defaults to true.
Impersonation bool
Defaults to true.
SystemSettingsId string
The ID of this resource.
avatars String
Defaults to gravatar,initials.
defaultTokenDuration String
Defaults to minutes=30.
defaultTokenLength Double
Defaults to 60.
defaultUserChangeEmail Boolean
Defaults to false.
defaultUserChangeName Boolean
Defaults to true.
defaultUserChangeUsername Boolean
Defaults to false.
eventRetention String
Defaults to days=365.
footerLinks List<Map<String,String>>
gdprCompliance Boolean
Defaults to true.
impersonation Boolean
Defaults to true.
systemSettingsId String
The ID of this resource.
avatars string
Defaults to gravatar,initials.
defaultTokenDuration string
Defaults to minutes=30.
defaultTokenLength number
Defaults to 60.
defaultUserChangeEmail boolean
Defaults to false.
defaultUserChangeName boolean
Defaults to true.
defaultUserChangeUsername boolean
Defaults to false.
eventRetention string
Defaults to days=365.
footerLinks {[key: string]: string}[]
gdprCompliance boolean
Defaults to true.
impersonation boolean
Defaults to true.
systemSettingsId string
The ID of this resource.
avatars str
Defaults to gravatar,initials.
default_token_duration str
Defaults to minutes=30.
default_token_length float
Defaults to 60.
default_user_change_email bool
Defaults to false.
default_user_change_name bool
Defaults to true.
default_user_change_username bool
Defaults to false.
event_retention str
Defaults to days=365.
footer_links Sequence[Mapping[str, str]]
gdpr_compliance bool
Defaults to true.
impersonation bool
Defaults to true.
system_settings_id str
The ID of this resource.
avatars String
Defaults to gravatar,initials.
defaultTokenDuration String
Defaults to minutes=30.
defaultTokenLength Number
Defaults to 60.
defaultUserChangeEmail Boolean
Defaults to false.
defaultUserChangeName Boolean
Defaults to true.
defaultUserChangeUsername Boolean
Defaults to false.
eventRetention String
Defaults to days=365.
footerLinks List<Map<String>>
gdprCompliance Boolean
Defaults to true.
impersonation Boolean
Defaults to true.
systemSettingsId String
The ID of this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the SystemSettings resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing SystemSettings Resource

Get an existing SystemSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SystemSettingsState, opts?: CustomResourceOptions): SystemSettings
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        avatars: Optional[str] = None,
        default_token_duration: Optional[str] = None,
        default_token_length: Optional[float] = None,
        default_user_change_email: Optional[bool] = None,
        default_user_change_name: Optional[bool] = None,
        default_user_change_username: Optional[bool] = None,
        event_retention: Optional[str] = None,
        footer_links: Optional[Sequence[Mapping[str, str]]] = None,
        gdpr_compliance: Optional[bool] = None,
        impersonation: Optional[bool] = None,
        system_settings_id: Optional[str] = None) -> SystemSettings
func GetSystemSettings(ctx *Context, name string, id IDInput, state *SystemSettingsState, opts ...ResourceOption) (*SystemSettings, error)
public static SystemSettings Get(string name, Input<string> id, SystemSettingsState? state, CustomResourceOptions? opts = null)
public static SystemSettings get(String name, Output<String> id, SystemSettingsState state, CustomResourceOptions options)
resources:  _:    type: authentik:SystemSettings    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Avatars string
Defaults to gravatar,initials.
DefaultTokenDuration string
Defaults to minutes=30.
DefaultTokenLength double
Defaults to 60.
DefaultUserChangeEmail bool
Defaults to false.
DefaultUserChangeName bool
Defaults to true.
DefaultUserChangeUsername bool
Defaults to false.
EventRetention string
Defaults to days=365.
FooterLinks List<ImmutableDictionary<string, string>>
GdprCompliance bool
Defaults to true.
Impersonation bool
Defaults to true.
SystemSettingsId string
The ID of this resource.
Avatars string
Defaults to gravatar,initials.
DefaultTokenDuration string
Defaults to minutes=30.
DefaultTokenLength float64
Defaults to 60.
DefaultUserChangeEmail bool
Defaults to false.
DefaultUserChangeName bool
Defaults to true.
DefaultUserChangeUsername bool
Defaults to false.
EventRetention string
Defaults to days=365.
FooterLinks []map[string]string
GdprCompliance bool
Defaults to true.
Impersonation bool
Defaults to true.
SystemSettingsId string
The ID of this resource.
avatars String
Defaults to gravatar,initials.
defaultTokenDuration String
Defaults to minutes=30.
defaultTokenLength Double
Defaults to 60.
defaultUserChangeEmail Boolean
Defaults to false.
defaultUserChangeName Boolean
Defaults to true.
defaultUserChangeUsername Boolean
Defaults to false.
eventRetention String
Defaults to days=365.
footerLinks List<Map<String,String>>
gdprCompliance Boolean
Defaults to true.
impersonation Boolean
Defaults to true.
systemSettingsId String
The ID of this resource.
avatars string
Defaults to gravatar,initials.
defaultTokenDuration string
Defaults to minutes=30.
defaultTokenLength number
Defaults to 60.
defaultUserChangeEmail boolean
Defaults to false.
defaultUserChangeName boolean
Defaults to true.
defaultUserChangeUsername boolean
Defaults to false.
eventRetention string
Defaults to days=365.
footerLinks {[key: string]: string}[]
gdprCompliance boolean
Defaults to true.
impersonation boolean
Defaults to true.
systemSettingsId string
The ID of this resource.
avatars str
Defaults to gravatar,initials.
default_token_duration str
Defaults to minutes=30.
default_token_length float
Defaults to 60.
default_user_change_email bool
Defaults to false.
default_user_change_name bool
Defaults to true.
default_user_change_username bool
Defaults to false.
event_retention str
Defaults to days=365.
footer_links Sequence[Mapping[str, str]]
gdpr_compliance bool
Defaults to true.
impersonation bool
Defaults to true.
system_settings_id str
The ID of this resource.
avatars String
Defaults to gravatar,initials.
defaultTokenDuration String
Defaults to minutes=30.
defaultTokenLength Number
Defaults to 60.
defaultUserChangeEmail Boolean
Defaults to false.
defaultUserChangeName Boolean
Defaults to true.
defaultUserChangeUsername Boolean
Defaults to false.
eventRetention String
Defaults to days=365.
footerLinks List<Map<String>>
gdprCompliance Boolean
Defaults to true.
impersonation Boolean
Defaults to true.
systemSettingsId String
The ID of this resource.

Import

{{codefile “shell” “examples/resources/authentik_system_settings/import.sh”}}

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
authentik goauthentik/terraform-provider-authentik
License
Notes
This Pulumi package is based on the authentik Terraform Provider.