Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zitadel
  3. API Docs
  4. DefaultDomainPolicy
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.DefaultDomainPolicy

Explore with Pulumi AI

zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

Resource representing the default domain policy.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.DefaultDomainPolicy("default", new()
    {
        UserLoginMustBeDomain = false,
        ValidateOrgDomains = true,
        SmtpSenderAddressMatchesInstanceDomain = true,
    });

});
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.NewDefaultDomainPolicy(ctx, "default", &zitadel.DefaultDomainPolicyArgs{
			UserLoginMustBeDomain:                  pulumi.Bool(false),
			ValidateOrgDomains:                     pulumi.Bool(true),
			SmtpSenderAddressMatchesInstanceDomain: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.DefaultDomainPolicy;
import com.pulumi.zitadel.DefaultDomainPolicyArgs;
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 default_ = new DefaultDomainPolicy("default", DefaultDomainPolicyArgs.builder()        
            .userLoginMustBeDomain(false)
            .validateOrgDomains(true)
            .smtpSenderAddressMatchesInstanceDomain(true)
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";

const _default = new zitadel.DefaultDomainPolicy("default", {
    userLoginMustBeDomain: false,
    validateOrgDomains: true,
    smtpSenderAddressMatchesInstanceDomain: true,
});
Copy
import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.DefaultDomainPolicy("default",
    user_login_must_be_domain=False,
    validate_org_domains=True,
    smtp_sender_address_matches_instance_domain=True)
Copy
resources:
  default:
    type: zitadel:DefaultDomainPolicy
    properties:
      userLoginMustBeDomain: false
      validateOrgDomains: true
      smtpSenderAddressMatchesInstanceDomain: true
Copy

Create DefaultDomainPolicy Resource

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

Constructor syntax

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

@overload
def DefaultDomainPolicy(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        smtp_sender_address_matches_instance_domain: Optional[bool] = None,
                        user_login_must_be_domain: Optional[bool] = None,
                        validate_org_domains: Optional[bool] = None)
func NewDefaultDomainPolicy(ctx *Context, name string, args DefaultDomainPolicyArgs, opts ...ResourceOption) (*DefaultDomainPolicy, error)
public DefaultDomainPolicy(string name, DefaultDomainPolicyArgs args, CustomResourceOptions? opts = null)
public DefaultDomainPolicy(String name, DefaultDomainPolicyArgs args)
public DefaultDomainPolicy(String name, DefaultDomainPolicyArgs args, CustomResourceOptions options)

type: zitadel:DefaultDomainPolicy
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 This property is required. DefaultDomainPolicyArgs
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 This property is required. DefaultDomainPolicyArgs
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 This property is required. DefaultDomainPolicyArgs
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 This property is required. DefaultDomainPolicyArgs
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. DefaultDomainPolicyArgs
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 defaultDomainPolicyResource = new Zitadel.DefaultDomainPolicy("defaultDomainPolicyResource", new()
{
    SmtpSenderAddressMatchesInstanceDomain = false,
    UserLoginMustBeDomain = false,
    ValidateOrgDomains = false,
});
Copy
example, err := zitadel.NewDefaultDomainPolicy(ctx, "defaultDomainPolicyResource", &zitadel.DefaultDomainPolicyArgs{
	SmtpSenderAddressMatchesInstanceDomain: pulumi.Bool(false),
	UserLoginMustBeDomain:                  pulumi.Bool(false),
	ValidateOrgDomains:                     pulumi.Bool(false),
})
Copy
var defaultDomainPolicyResource = new DefaultDomainPolicy("defaultDomainPolicyResource", DefaultDomainPolicyArgs.builder()
    .smtpSenderAddressMatchesInstanceDomain(false)
    .userLoginMustBeDomain(false)
    .validateOrgDomains(false)
    .build());
Copy
default_domain_policy_resource = zitadel.DefaultDomainPolicy("defaultDomainPolicyResource",
    smtp_sender_address_matches_instance_domain=False,
    user_login_must_be_domain=False,
    validate_org_domains=False)
Copy
const defaultDomainPolicyResource = new zitadel.DefaultDomainPolicy("defaultDomainPolicyResource", {
    smtpSenderAddressMatchesInstanceDomain: false,
    userLoginMustBeDomain: false,
    validateOrgDomains: false,
});
Copy
type: zitadel:DefaultDomainPolicy
properties:
    smtpSenderAddressMatchesInstanceDomain: false
    userLoginMustBeDomain: false
    validateOrgDomains: false
Copy

DefaultDomainPolicy 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 DefaultDomainPolicy resource accepts the following input properties:

SmtpSenderAddressMatchesInstanceDomain This property is required. bool
UserLoginMustBeDomain This property is required. bool
User login must be domain
ValidateOrgDomains This property is required. bool
Validate organization domains
SmtpSenderAddressMatchesInstanceDomain This property is required. bool
UserLoginMustBeDomain This property is required. bool
User login must be domain
ValidateOrgDomains This property is required. bool
Validate organization domains
smtpSenderAddressMatchesInstanceDomain This property is required. Boolean
userLoginMustBeDomain This property is required. Boolean
User login must be domain
validateOrgDomains This property is required. Boolean
Validate organization domains
smtpSenderAddressMatchesInstanceDomain This property is required. boolean
userLoginMustBeDomain This property is required. boolean
User login must be domain
validateOrgDomains This property is required. boolean
Validate organization domains
smtp_sender_address_matches_instance_domain This property is required. bool
user_login_must_be_domain This property is required. bool
User login must be domain
validate_org_domains This property is required. bool
Validate organization domains
smtpSenderAddressMatchesInstanceDomain This property is required. Boolean
userLoginMustBeDomain This property is required. Boolean
User login must be domain
validateOrgDomains This property is required. Boolean
Validate organization domains

Outputs

All input properties are implicitly available as output properties. Additionally, the DefaultDomainPolicy 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 DefaultDomainPolicy Resource

Get an existing DefaultDomainPolicy 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?: DefaultDomainPolicyState, opts?: CustomResourceOptions): DefaultDomainPolicy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        smtp_sender_address_matches_instance_domain: Optional[bool] = None,
        user_login_must_be_domain: Optional[bool] = None,
        validate_org_domains: Optional[bool] = None) -> DefaultDomainPolicy
func GetDefaultDomainPolicy(ctx *Context, name string, id IDInput, state *DefaultDomainPolicyState, opts ...ResourceOption) (*DefaultDomainPolicy, error)
public static DefaultDomainPolicy Get(string name, Input<string> id, DefaultDomainPolicyState? state, CustomResourceOptions? opts = null)
public static DefaultDomainPolicy get(String name, Output<String> id, DefaultDomainPolicyState state, CustomResourceOptions options)
resources:  _:    type: zitadel:DefaultDomainPolicy    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:
SmtpSenderAddressMatchesInstanceDomain bool
UserLoginMustBeDomain bool
User login must be domain
ValidateOrgDomains bool
Validate organization domains
SmtpSenderAddressMatchesInstanceDomain bool
UserLoginMustBeDomain bool
User login must be domain
ValidateOrgDomains bool
Validate organization domains
smtpSenderAddressMatchesInstanceDomain Boolean
userLoginMustBeDomain Boolean
User login must be domain
validateOrgDomains Boolean
Validate organization domains
smtpSenderAddressMatchesInstanceDomain boolean
userLoginMustBeDomain boolean
User login must be domain
validateOrgDomains boolean
Validate organization domains
smtp_sender_address_matches_instance_domain bool
user_login_must_be_domain bool
User login must be domain
validate_org_domains bool
Validate organization domains
smtpSenderAddressMatchesInstanceDomain Boolean
userLoginMustBeDomain Boolean
User login must be domain
validateOrgDomains Boolean
Validate organization domains

Import

bash The resource can be imported using the ID format <>, e.g.

 $ pulumi import zitadel:index/defaultDomainPolicy:DefaultDomainPolicy imported ''
Copy

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

Package Details

Repository
zitadel pulumiverse/pulumi-zitadel
License
Apache-2.0
Notes
This Pulumi package is based on the zitadel Terraform Provider.
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel