zitadel.PrivacyPolicy
Resource representing the custom privacy policy of an organization.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;
return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.PrivacyPolicy("default", new()
    {
        OrgId = defaultZitadelOrg.Id,
        TosLink = "https://example.com/tos",
        PrivacyLink = "https://example.com/privacy",
        HelpLink = "https://example.com/help",
        SupportEmail = "support@example.com",
    });
});
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.NewPrivacyPolicy(ctx, "default", &zitadel.PrivacyPolicyArgs{
			OrgId:        pulumi.Any(defaultZitadelOrg.Id),
			TosLink:      pulumi.String("https://example.com/tos"),
			PrivacyLink:  pulumi.String("https://example.com/privacy"),
			HelpLink:     pulumi.String("https://example.com/help"),
			SupportEmail: pulumi.String("support@example.com"),
		})
		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.PrivacyPolicy;
import com.pulumi.zitadel.PrivacyPolicyArgs;
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 PrivacyPolicy("default", PrivacyPolicyArgs.builder()        
            .orgId(defaultZitadelOrg.id())
            .tosLink("https://example.com/tos")
            .privacyLink("https://example.com/privacy")
            .helpLink("https://example.com/help")
            .supportEmail("support@example.com")
            .build());
    }
}
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";
const _default = new zitadel.PrivacyPolicy("default", {
    orgId: defaultZitadelOrg.id,
    tosLink: "https://example.com/tos",
    privacyLink: "https://example.com/privacy",
    helpLink: "https://example.com/help",
    supportEmail: "support@example.com",
});
import pulumi
import pulumiverse_zitadel as zitadel
default = zitadel.PrivacyPolicy("default",
    org_id=default_zitadel_org["id"],
    tos_link="https://example.com/tos",
    privacy_link="https://example.com/privacy",
    help_link="https://example.com/help",
    support_email="support@example.com")
resources:
  default:
    type: zitadel:PrivacyPolicy
    properties:
      orgId: ${defaultZitadelOrg.id}
      tosLink: https://example.com/tos
      privacyLink: https://example.com/privacy
      helpLink: https://example.com/help
      supportEmail: support@example.com
Create PrivacyPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PrivacyPolicy(name: string, args?: PrivacyPolicyArgs, opts?: CustomResourceOptions);@overload
def PrivacyPolicy(resource_name: str,
                  args: Optional[PrivacyPolicyArgs] = None,
                  opts: Optional[ResourceOptions] = None)
@overload
def PrivacyPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  help_link: Optional[str] = None,
                  org_id: Optional[str] = None,
                  privacy_link: Optional[str] = None,
                  support_email: Optional[str] = None,
                  tos_link: Optional[str] = None)func NewPrivacyPolicy(ctx *Context, name string, args *PrivacyPolicyArgs, opts ...ResourceOption) (*PrivacyPolicy, error)public PrivacyPolicy(string name, PrivacyPolicyArgs? args = null, CustomResourceOptions? opts = null)
public PrivacyPolicy(String name, PrivacyPolicyArgs args)
public PrivacyPolicy(String name, PrivacyPolicyArgs args, CustomResourceOptions options)
type: zitadel:PrivacyPolicy
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 PrivacyPolicyArgs
- 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 PrivacyPolicyArgs
- 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 PrivacyPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivacyPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PrivacyPolicyArgs
- 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 privacyPolicyResource = new Zitadel.PrivacyPolicy("privacyPolicyResource", new()
{
    HelpLink = "string",
    OrgId = "string",
    PrivacyLink = "string",
    SupportEmail = "string",
    TosLink = "string",
});
example, err := zitadel.NewPrivacyPolicy(ctx, "privacyPolicyResource", &zitadel.PrivacyPolicyArgs{
	HelpLink:     pulumi.String("string"),
	OrgId:        pulumi.String("string"),
	PrivacyLink:  pulumi.String("string"),
	SupportEmail: pulumi.String("string"),
	TosLink:      pulumi.String("string"),
})
var privacyPolicyResource = new PrivacyPolicy("privacyPolicyResource", PrivacyPolicyArgs.builder()
    .helpLink("string")
    .orgId("string")
    .privacyLink("string")
    .supportEmail("string")
    .tosLink("string")
    .build());
privacy_policy_resource = zitadel.PrivacyPolicy("privacyPolicyResource",
    help_link="string",
    org_id="string",
    privacy_link="string",
    support_email="string",
    tos_link="string")
const privacyPolicyResource = new zitadel.PrivacyPolicy("privacyPolicyResource", {
    helpLink: "string",
    orgId: "string",
    privacyLink: "string",
    supportEmail: "string",
    tosLink: "string",
});
type: zitadel:PrivacyPolicy
properties:
    helpLink: string
    orgId: string
    privacyLink: string
    supportEmail: string
    tosLink: string
PrivacyPolicy 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 PrivacyPolicy resource accepts the following input properties:
- HelpLink string
- OrgId string
- ID of the organization
- PrivacyLink string
- SupportEmail string
- TosLink string
- HelpLink string
- OrgId string
- ID of the organization
- PrivacyLink string
- SupportEmail string
- TosLink string
- helpLink String
- orgId String
- ID of the organization
- privacyLink String
- supportEmail String
- tosLink String
- helpLink string
- orgId string
- ID of the organization
- privacyLink string
- supportEmail string
- tosLink string
- help_link str
- org_id str
- ID of the organization
- privacy_link str
- support_email str
- tos_link str
- helpLink String
- orgId String
- ID of the organization
- privacyLink String
- supportEmail String
- tosLink String
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivacyPolicy 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 PrivacyPolicy Resource
Get an existing PrivacyPolicy 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?: PrivacyPolicyState, opts?: CustomResourceOptions): PrivacyPolicy@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        help_link: Optional[str] = None,
        org_id: Optional[str] = None,
        privacy_link: Optional[str] = None,
        support_email: Optional[str] = None,
        tos_link: Optional[str] = None) -> PrivacyPolicyfunc GetPrivacyPolicy(ctx *Context, name string, id IDInput, state *PrivacyPolicyState, opts ...ResourceOption) (*PrivacyPolicy, error)public static PrivacyPolicy Get(string name, Input<string> id, PrivacyPolicyState? state, CustomResourceOptions? opts = null)public static PrivacyPolicy get(String name, Output<String> id, PrivacyPolicyState state, CustomResourceOptions options)resources:  _:    type: zitadel:PrivacyPolicy    get:      id: ${id}- 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.
- HelpLink string
- OrgId string
- ID of the organization
- PrivacyLink string
- SupportEmail string
- TosLink string
- HelpLink string
- OrgId string
- ID of the organization
- PrivacyLink string
- SupportEmail string
- TosLink string
- helpLink String
- orgId String
- ID of the organization
- privacyLink String
- supportEmail String
- tosLink String
- helpLink string
- orgId string
- ID of the organization
- privacyLink string
- supportEmail string
- tosLink string
- help_link str
- org_id str
- ID of the organization
- privacy_link str
- support_email str
- tos_link str
- helpLink String
- orgId String
- ID of the organization
- privacyLink String
- supportEmail String
- tosLink String
Import
bash The resource can be imported using the ID format <[org_id]>, e.g.
 $ pulumi import zitadel:index/privacyPolicy:PrivacyPolicy imported '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 zitadelTerraform Provider.
