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

zitadel.UserMetadata

Explore with Pulumi AI

zitadel logo
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 <user_id:key[:org_id]>, e.g.

     $ pulumi import zitadel:index/userMetadata:UserMetadata imported '123456789012345678:a_key:123456789012345678'

    Example Usage

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

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

});

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

    }
}

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

const _default = new zitadel.UserMetadata("default", {
    orgId: defaultZitadelOrg.id,
    userId: defaultZitadelHumanUser.id,
    key: "a_key",
    value: "a_value",
});

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.UserMetadata("default",
    org_id=default_zitadel_org["id"],
    user_id=default_zitadel_human_user["id"],
    key="a_key",
    value="a_value")

    resources:
  default:
    type: zitadel:UserMetadata
    properties:
      orgId: ${defaultZitadelOrg.id}
      userId: ${defaultZitadelHumanUser.id}
      key: a_key
      value: a_value

    Create UserMetadata Resource

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

    Constructor syntax

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

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

    type: zitadel:UserMetadata
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 UserMetadataArgs
    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 UserMetadataArgs
    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 UserMetadataArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserMetadataArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserMetadataArgs
    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 userMetadataResource = new Zitadel.UserMetadata("userMetadataResource", new()
{
    Key = "string",
    UserId = "string",
    Value = "string",
    OrgId = "string",
});

    example, err := zitadel.NewUserMetadata(ctx, "userMetadataResource", &zitadel.UserMetadataArgs{
	Key:    pulumi.String("string"),
	UserId: pulumi.String("string"),
	Value:  pulumi.String("string"),
	OrgId:  pulumi.String("string"),
})

    var userMetadataResource = new UserMetadata("userMetadataResource", UserMetadataArgs.builder()
    .key("string")
    .userId("string")
    .value("string")
    .orgId("string")
    .build());

    user_metadata_resource = zitadel.UserMetadata("userMetadataResource",
    key="string",
    user_id="string",
    value="string",
    org_id="string")

    const userMetadataResource = new zitadel.UserMetadata("userMetadataResource", {
    key: "string",
    userId: "string",
    value: "string",
    orgId: "string",
});

    type: zitadel:UserMetadata
properties:
    key: string
    orgId: string
    userId: string
    value: string

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

    Key string
    The key of a metadata entry
    UserId string
    ID of the user
    Value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    OrgId string
    ID of the organization
    Key string
    The key of a metadata entry
    UserId string
    ID of the user
    Value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    OrgId string
    ID of the organization
    key String
    The key of a metadata entry
    userId String
    ID of the user
    value String
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    orgId String
    ID of the organization
    key string
    The key of a metadata entry
    userId string
    ID of the user
    value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    orgId string
    ID of the organization
    key str
    The key of a metadata entry
    user_id str
    ID of the user
    value str
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    org_id str
    ID of the organization
    key String
    The key of a metadata entry
    userId String
    ID of the user
    value String
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    orgId String
    ID of the organization

    Outputs

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

    Get an existing UserMetadata 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?: UserMetadataState, opts?: CustomResourceOptions): UserMetadata
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        org_id: Optional[str] = None,
        user_id: Optional[str] = None,
        value: Optional[str] = None) -> UserMetadata
    func GetUserMetadata(ctx *Context, name string, id IDInput, state *UserMetadataState, opts ...ResourceOption) (*UserMetadata, error)
    public static UserMetadata Get(string name, Input<string> id, UserMetadataState? state, CustomResourceOptions? opts = null)
    public static UserMetadata get(String name, Output<String> id, UserMetadataState state, CustomResourceOptions options)
    resources:  _:    type: zitadel:UserMetadata    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.
    The following state arguments are supported:
    Key string
    The key of a metadata entry
    OrgId string
    ID of the organization
    UserId string
    ID of the user
    Value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    Key string
    The key of a metadata entry
    OrgId string
    ID of the organization
    UserId string
    ID of the user
    Value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    key String
    The key of a metadata entry
    orgId String
    ID of the organization
    userId String
    ID of the user
    value String
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    key string
    The key of a metadata entry
    orgId string
    ID of the organization
    userId string
    ID of the user
    value string
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    key str
    The key of a metadata entry
    org_id str
    ID of the organization
    user_id str
    ID of the user
    value str
    The string representation of a metadata entry value. For binary data, use the base64encode function.
    key String
    The key of a metadata entry
    orgId String
    ID of the organization
    userId String
    ID of the user
    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 logo
    zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
    pulumiverse/pulumi-zitadel