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

zitadel.OrgMetadata

Explore with Pulumi AI

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

Import

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

 $ pulumi import zitadel:index/orgMetadata:OrgMetadata imported 'a_key:123456789012345678'
Copy

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.OrgMetadata("default", new()
    {
        OrgId = defaultZitadelOrg.Id,
        Key = "a_key",
        Value = "a_value",
    });

});
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.NewOrgMetadata(ctx, "default", &zitadel.OrgMetadataArgs{
			OrgId: pulumi.Any(defaultZitadelOrg.Id),
			Key:   pulumi.String("a_key"),
			Value: pulumi.String("a_value"),
		})
		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.OrgMetadata;
import com.pulumi.zitadel.OrgMetadataArgs;
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 OrgMetadata("default", OrgMetadataArgs.builder()        
            .orgId(defaultZitadelOrg.id())
            .key("a_key")
            .value("a_value")
            .build());

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

const _default = new zitadel.OrgMetadata("default", {
    orgId: defaultZitadelOrg.id,
    key: "a_key",
    value: "a_value",
});
Copy
import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.OrgMetadata("default",
    org_id=default_zitadel_org["id"],
    key="a_key",
    value="a_value")
Copy
resources:
  default:
    type: zitadel:OrgMetadata
    properties:
      orgId: ${defaultZitadelOrg.id}
      key: a_key
      value: a_value
Copy

Create OrgMetadata Resource

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

Constructor syntax

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

@overload
def OrgMetadata(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                key: Optional[str] = None,
                value: Optional[str] = None,
                org_id: Optional[str] = None)
func NewOrgMetadata(ctx *Context, name string, args OrgMetadataArgs, opts ...ResourceOption) (*OrgMetadata, error)
public OrgMetadata(string name, OrgMetadataArgs args, CustomResourceOptions? opts = null)
public OrgMetadata(String name, OrgMetadataArgs args)
public OrgMetadata(String name, OrgMetadataArgs args, CustomResourceOptions options)

type: zitadel:OrgMetadata
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. OrgMetadataArgs
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. OrgMetadataArgs
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. OrgMetadataArgs
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. OrgMetadataArgs
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. OrgMetadataArgs
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 orgMetadataResource = new Zitadel.OrgMetadata("orgMetadataResource", new()
{
    Key = "string",
    Value = "string",
    OrgId = "string",
});
Copy
example, err := zitadel.NewOrgMetadata(ctx, "orgMetadataResource", &zitadel.OrgMetadataArgs{
	Key:   pulumi.String("string"),
	Value: pulumi.String("string"),
	OrgId: pulumi.String("string"),
})
Copy
var orgMetadataResource = new OrgMetadata("orgMetadataResource", OrgMetadataArgs.builder()
    .key("string")
    .value("string")
    .orgId("string")
    .build());
Copy
org_metadata_resource = zitadel.OrgMetadata("orgMetadataResource",
    key="string",
    value="string",
    org_id="string")
Copy
const orgMetadataResource = new zitadel.OrgMetadata("orgMetadataResource", {
    key: "string",
    value: "string",
    orgId: "string",
});
Copy
type: zitadel:OrgMetadata
properties:
    key: string
    orgId: string
    value: string
Copy

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

Key
This property is required.
Changes to this property will trigger replacement.
string
The key of a metadata entry
Value This property is required. string
The string representation of a metadata entry value. For binary data, use the base64encode function.
OrgId Changes to this property will trigger replacement. string
ID of the organization
Key
This property is required.
Changes to this property will trigger replacement.
string
The key of a metadata entry
Value This property is required. string
The string representation of a metadata entry value. For binary data, use the base64encode function.
OrgId Changes to this property will trigger replacement. string
ID of the organization
key
This property is required.
Changes to this property will trigger replacement.
String
The key of a metadata entry
value This property is required. String
The string representation of a metadata entry value. For binary data, use the base64encode function.
orgId Changes to this property will trigger replacement. String
ID of the organization
key
This property is required.
Changes to this property will trigger replacement.
string
The key of a metadata entry
value This property is required. string
The string representation of a metadata entry value. For binary data, use the base64encode function.
orgId Changes to this property will trigger replacement. string
ID of the organization
key
This property is required.
Changes to this property will trigger replacement.
str
The key of a metadata entry
value This property is required. str
The string representation of a metadata entry value. For binary data, use the base64encode function.
org_id Changes to this property will trigger replacement. str
ID of the organization
key
This property is required.
Changes to this property will trigger replacement.
String
The key of a metadata entry
value This property is required. String
The string representation of a metadata entry value. For binary data, use the base64encode function.
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 OrgMetadata 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 OrgMetadata Resource

Get an existing OrgMetadata 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?: OrgMetadataState, opts?: CustomResourceOptions): OrgMetadata
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        org_id: Optional[str] = None,
        value: Optional[str] = None) -> OrgMetadata
func GetOrgMetadata(ctx *Context, name string, id IDInput, state *OrgMetadataState, opts ...ResourceOption) (*OrgMetadata, error)
public static OrgMetadata Get(string name, Input<string> id, OrgMetadataState? state, CustomResourceOptions? opts = null)
public static OrgMetadata get(String name, Output<String> id, OrgMetadataState state, CustomResourceOptions options)
resources:  _:    type: zitadel:OrgMetadata    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:
Key Changes to this property will trigger replacement. string
The key of a metadata entry
OrgId Changes to this property will trigger replacement. string
ID of the organization
Value string
The string representation of a metadata entry value. For binary data, use the base64encode function.
Key Changes to this property will trigger replacement. string
The key of a metadata entry
OrgId Changes to this property will trigger replacement. string
ID of the organization
Value string
The string representation of a metadata entry value. For binary data, use the base64encode function.
key Changes to this property will trigger replacement. String
The key of a metadata entry
orgId Changes to this property will trigger replacement. String
ID of the organization
value String
The string representation of a metadata entry value. For binary data, use the base64encode function.
key Changes to this property will trigger replacement. string
The key of a metadata entry
orgId Changes to this property will trigger replacement. string
ID of the organization
value string
The string representation of a metadata entry value. For binary data, use the base64encode function.
key Changes to this property will trigger replacement. str
The key of a metadata entry
org_id Changes to this property will trigger replacement. str
ID of the organization
value str
The string representation of a metadata entry value. For binary data, use the base64encode function.
key Changes to this property will trigger replacement. String
The key of a metadata entry
orgId Changes to this property will trigger replacement. String
ID of the organization
value String
The string representation of a metadata entry value. For binary data, use the base64encode function.

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