Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zitadel
  3. API Docs
  4. Project
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.Project

Explore with Pulumi AI

zitadel logo
zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing the project, which can then be granted to different organizations or users directly, containing different applications.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.Project("default", new()
    {
        OrgId = data.Zitadel_org.Default.Id,
        ProjectRoleAssertion = true,
        ProjectRoleCheck = true,
        HasProjectCheck = true,
        PrivateLabelingSetting = "PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY",
    });

});

    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.NewProject(ctx, "default", &zitadel.ProjectArgs{
			OrgId:                  pulumi.Any(data.Zitadel_org.Default.Id),
			ProjectRoleAssertion:   pulumi.Bool(true),
			ProjectRoleCheck:       pulumi.Bool(true),
			HasProjectCheck:        pulumi.Bool(true),
			PrivateLabelingSetting: pulumi.String("PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.zitadel.Project;
import com.pulumi.zitadel.ProjectArgs;
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 Project("default", ProjectArgs.builder()        
            .orgId(data.zitadel_org().default().id())
            .projectRoleAssertion(true)
            .projectRoleCheck(true)
            .hasProjectCheck(true)
            .privateLabelingSetting("PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY")
            .build());

    }
}

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.Project("default",
    org_id=data["zitadel_org"]["default"]["id"],
    project_role_assertion=True,
    project_role_check=True,
    has_project_check=True,
    private_labeling_setting="PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY")

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

const _default = new zitadel.Project("default", {
    orgId: data.zitadel_org["default"].id,
    projectRoleAssertion: true,
    projectRoleCheck: true,
    hasProjectCheck: true,
    privateLabelingSetting: "PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY",
});

    resources:
  default:
    type: zitadel:Project
    properties:
      orgId: ${data.zitadel_org.default.id}
      projectRoleAssertion: true
      projectRoleCheck: true
      hasProjectCheck: true
      privateLabelingSetting: PRIVATE_LABELING_SETTING_ENFORCE_PROJECT_RESOURCE_OWNER_POLICY

    Create Project Resource

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

    Constructor syntax

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

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            has_project_check: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            private_labeling_setting: Optional[str] = None,
            project_role_assertion: Optional[bool] = None,
            project_role_check: Optional[bool] = None)
    func NewProject(ctx *Context, name string, args *ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs? args = null, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)

    type: zitadel:Project
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    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 projectResource = new Zitadel.Project("projectResource", new()
{
    HasProjectCheck = false,
    Name = "string",
    OrgId = "string",
    PrivateLabelingSetting = "string",
    ProjectRoleAssertion = false,
    ProjectRoleCheck = false,
});

    example, err := zitadel.NewProject(ctx, "projectResource", &zitadel.ProjectArgs{
	HasProjectCheck:        pulumi.Bool(false),
	Name:                   pulumi.String("string"),
	OrgId:                  pulumi.String("string"),
	PrivateLabelingSetting: pulumi.String("string"),
	ProjectRoleAssertion:   pulumi.Bool(false),
	ProjectRoleCheck:       pulumi.Bool(false),
})

    var projectResource = new Project("projectResource", ProjectArgs.builder()
    .hasProjectCheck(false)
    .name("string")
    .orgId("string")
    .privateLabelingSetting("string")
    .projectRoleAssertion(false)
    .projectRoleCheck(false)
    .build());

    project_resource = zitadel.Project("projectResource",
    has_project_check=False,
    name="string",
    org_id="string",
    private_labeling_setting="string",
    project_role_assertion=False,
    project_role_check=False)

    const projectResource = new zitadel.Project("projectResource", {
    hasProjectCheck: false,
    name: "string",
    orgId: "string",
    privateLabelingSetting: "string",
    projectRoleAssertion: false,
    projectRoleCheck: false,
});

    type: zitadel:Project
properties:
    hasProjectCheck: false
    name: string
    orgId: string
    privateLabelingSetting: string
    projectRoleAssertion: false
    projectRoleCheck: false

    Project Resource Properties

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

    Inputs

    The Project resource accepts the following input properties:

    HasProjectCheck bool
    ZITADEL checks if the org of the user has permission to this project
    Name string
    Name of the project
    OrgId string
    ID of the organization
    PrivateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    ProjectRoleAssertion bool
    describes if roles of user should be added in token
    ProjectRoleCheck bool
    ZITADEL checks if the user has at least one on this project
    HasProjectCheck bool
    ZITADEL checks if the org of the user has permission to this project
    Name string
    Name of the project
    OrgId string
    ID of the organization
    PrivateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    ProjectRoleAssertion bool
    describes if roles of user should be added in token
    ProjectRoleCheck bool
    ZITADEL checks if the user has at least one on this project
    hasProjectCheck Boolean
    ZITADEL checks if the org of the user has permission to this project
    name String
    Name of the project
    orgId String
    ID of the organization
    privateLabelingSetting String
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion Boolean
    describes if roles of user should be added in token
    projectRoleCheck Boolean
    ZITADEL checks if the user has at least one on this project
    hasProjectCheck boolean
    ZITADEL checks if the org of the user has permission to this project
    name string
    Name of the project
    orgId string
    ID of the organization
    privateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion boolean
    describes if roles of user should be added in token
    projectRoleCheck boolean
    ZITADEL checks if the user has at least one on this project
    has_project_check bool
    ZITADEL checks if the org of the user has permission to this project
    name str
    Name of the project
    org_id str
    ID of the organization
    private_labeling_setting str
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    project_role_assertion bool
    describes if roles of user should be added in token
    project_role_check bool
    ZITADEL checks if the user has at least one on this project
    hasProjectCheck Boolean
    ZITADEL checks if the org of the user has permission to this project
    name String
    Name of the project
    orgId String
    ID of the organization
    privateLabelingSetting String
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion Boolean
    describes if roles of user should be added in token
    projectRoleCheck Boolean
    ZITADEL checks if the user has at least one on this project

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the project
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    State of the project
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the project
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    State of the project
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    State of the project
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    State of the project

    Look up Existing Project Resource

    Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        has_project_check: Optional[bool] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        private_labeling_setting: Optional[str] = None,
        project_role_assertion: Optional[bool] = None,
        project_role_check: Optional[bool] = None,
        state: Optional[str] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    HasProjectCheck bool
    ZITADEL checks if the org of the user has permission to this project
    Name string
    Name of the project
    OrgId string
    ID of the organization
    PrivateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    ProjectRoleAssertion bool
    describes if roles of user should be added in token
    ProjectRoleCheck bool
    ZITADEL checks if the user has at least one on this project
    State string
    State of the project
    HasProjectCheck bool
    ZITADEL checks if the org of the user has permission to this project
    Name string
    Name of the project
    OrgId string
    ID of the organization
    PrivateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    ProjectRoleAssertion bool
    describes if roles of user should be added in token
    ProjectRoleCheck bool
    ZITADEL checks if the user has at least one on this project
    State string
    State of the project
    hasProjectCheck Boolean
    ZITADEL checks if the org of the user has permission to this project
    name String
    Name of the project
    orgId String
    ID of the organization
    privateLabelingSetting String
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion Boolean
    describes if roles of user should be added in token
    projectRoleCheck Boolean
    ZITADEL checks if the user has at least one on this project
    state String
    State of the project
    hasProjectCheck boolean
    ZITADEL checks if the org of the user has permission to this project
    name string
    Name of the project
    orgId string
    ID of the organization
    privateLabelingSetting string
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion boolean
    describes if roles of user should be added in token
    projectRoleCheck boolean
    ZITADEL checks if the user has at least one on this project
    state string
    State of the project
    has_project_check bool
    ZITADEL checks if the org of the user has permission to this project
    name str
    Name of the project
    org_id str
    ID of the organization
    private_labeling_setting str
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    project_role_assertion bool
    describes if roles of user should be added in token
    project_role_check bool
    ZITADEL checks if the user has at least one on this project
    state str
    State of the project
    hasProjectCheck Boolean
    ZITADEL checks if the org of the user has permission to this project
    name String
    Name of the project
    orgId String
    ID of the organization
    privateLabelingSetting String
    Defines from where the private labeling should be triggered, supported values: PRIVATELABELINGSETTINGUNSPECIFIED, PRIVATELABELINGSETTINGENFORCEPROJECTRESOURCEOWNERPOLICY, PRIVATELABELINGSETTINGALLOWLOGINUSERRESOURCEOWNERPOLICY
    projectRoleAssertion Boolean
    describes if roles of user should be added in token
    projectRoleCheck Boolean
    ZITADEL checks if the user has at least one on this project
    state String
    State of the project

    Import

    terraform The resource can be imported using the ID format <id[:org_id]>, e.g.

     $ pulumi import zitadel:index/project:Project imported '123456789012345678:123456789012345678'

    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 logo
    zitadel v0.1.8 published on Thursday, May 30, 2024 by pulumiverse
    pulumiverse/pulumi-zitadel