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

zitadel.Domain

Explore with Pulumi AI

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

Resource representing a domain of the organization.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.Domain("default", new()
    {
        OrgId = defaultZitadelOrg.Id,
        Name = "zitadel.default.127.0.0.1.sslip.io",
        IsPrimary = false,
    });

});
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.NewDomain(ctx, "default", &zitadel.DomainArgs{
			OrgId:     pulumi.Any(defaultZitadelOrg.Id),
			Name:      pulumi.String("zitadel.default.127.0.0.1.sslip.io"),
			IsPrimary: pulumi.Bool(false),
		})
		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.Domain;
import com.pulumi.zitadel.DomainArgs;
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 Domain("default", DomainArgs.builder()        
            .orgId(defaultZitadelOrg.id())
            .name("zitadel.default.127.0.0.1.sslip.io")
            .isPrimary(false)
            .build());

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

const _default = new zitadel.Domain("default", {
    orgId: defaultZitadelOrg.id,
    name: "zitadel.default.127.0.0.1.sslip.io",
    isPrimary: false,
});
Copy
import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.Domain("default",
    org_id=default_zitadel_org["id"],
    name="zitadel.default.127.0.0.1.sslip.io",
    is_primary=False)
Copy
resources:
  default:
    type: zitadel:Domain
    properties:
      orgId: ${defaultZitadelOrg.id}
      name: zitadel.default.127.0.0.1.sslip.io
      isPrimary: false
Copy

Create Domain Resource

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

Constructor syntax

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

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           is_primary: Optional[bool] = None,
           name: Optional[str] = None,
           org_id: Optional[str] = None)
func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: zitadel:Domain
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 DomainArgs
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 DomainArgs
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 DomainArgs
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 DomainArgs
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. DomainArgs
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 domainResource = new Zitadel.Domain("domainResource", new()
{
    IsPrimary = false,
    Name = "string",
    OrgId = "string",
});
Copy
example, err := zitadel.NewDomain(ctx, "domainResource", &zitadel.DomainArgs{
	IsPrimary: pulumi.Bool(false),
	Name:      pulumi.String("string"),
	OrgId:     pulumi.String("string"),
})
Copy
var domainResource = new Domain("domainResource", DomainArgs.builder()
    .isPrimary(false)
    .name("string")
    .orgId("string")
    .build());
Copy
domain_resource = zitadel.Domain("domainResource",
    is_primary=False,
    name="string",
    org_id="string")
Copy
const domainResource = new zitadel.Domain("domainResource", {
    isPrimary: false,
    name: "string",
    orgId: "string",
});
Copy
type: zitadel:Domain
properties:
    isPrimary: false
    name: string
    orgId: string
Copy

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

IsPrimary bool
Is domain primary
Name Changes to this property will trigger replacement. string
Name of the domain
OrgId Changes to this property will trigger replacement. string
ID of the organization
IsPrimary bool
Is domain primary
Name Changes to this property will trigger replacement. string
Name of the domain
OrgId Changes to this property will trigger replacement. string
ID of the organization
isPrimary Boolean
Is domain primary
name Changes to this property will trigger replacement. String
Name of the domain
orgId Changes to this property will trigger replacement. String
ID of the organization
isPrimary boolean
Is domain primary
name Changes to this property will trigger replacement. string
Name of the domain
orgId Changes to this property will trigger replacement. string
ID of the organization
is_primary bool
Is domain primary
name Changes to this property will trigger replacement. str
Name of the domain
org_id Changes to this property will trigger replacement. str
ID of the organization
isPrimary Boolean
Is domain primary
name Changes to this property will trigger replacement. String
Name of the domain
orgId Changes to this property will trigger replacement. String
ID of the organization

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
IsVerified bool
Is domain verified
ValidationType int
Validation type
Id string
The provider-assigned unique ID for this managed resource.
IsVerified bool
Is domain verified
ValidationType int
Validation type
id String
The provider-assigned unique ID for this managed resource.
isVerified Boolean
Is domain verified
validationType Integer
Validation type
id string
The provider-assigned unique ID for this managed resource.
isVerified boolean
Is domain verified
validationType number
Validation type
id str
The provider-assigned unique ID for this managed resource.
is_verified bool
Is domain verified
validation_type int
Validation type
id String
The provider-assigned unique ID for this managed resource.
isVerified Boolean
Is domain verified
validationType Number
Validation type

Look up Existing Domain Resource

Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_primary: Optional[bool] = None,
        is_verified: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        validation_type: Optional[int] = None) -> Domain
func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
resources:  _:    type: zitadel:Domain    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:
IsPrimary bool
Is domain primary
IsVerified bool
Is domain verified
Name Changes to this property will trigger replacement. string
Name of the domain
OrgId Changes to this property will trigger replacement. string
ID of the organization
ValidationType int
Validation type
IsPrimary bool
Is domain primary
IsVerified bool
Is domain verified
Name Changes to this property will trigger replacement. string
Name of the domain
OrgId Changes to this property will trigger replacement. string
ID of the organization
ValidationType int
Validation type
isPrimary Boolean
Is domain primary
isVerified Boolean
Is domain verified
name Changes to this property will trigger replacement. String
Name of the domain
orgId Changes to this property will trigger replacement. String
ID of the organization
validationType Integer
Validation type
isPrimary boolean
Is domain primary
isVerified boolean
Is domain verified
name Changes to this property will trigger replacement. string
Name of the domain
orgId Changes to this property will trigger replacement. string
ID of the organization
validationType number
Validation type
is_primary bool
Is domain primary
is_verified bool
Is domain verified
name Changes to this property will trigger replacement. str
Name of the domain
org_id Changes to this property will trigger replacement. str
ID of the organization
validation_type int
Validation type
isPrimary Boolean
Is domain primary
isVerified Boolean
Is domain verified
name Changes to this property will trigger replacement. String
Name of the domain
orgId Changes to this property will trigger replacement. String
ID of the organization
validationType Number
Validation type

Import

bash The resource can be imported using the ID format name[:org_id], e.g.

 $ pulumi import zitadel:index/domain:Domain imported 'example.com:123456789012345678'
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