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

zitadel.InstanceMember

Explore with Pulumi AI

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

Resource representing the membership of a user on an instance, defined with the given role.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.InstanceMember("default", new()
    {
        UserId = defaultZitadelHumanUser.Id,
        Roles = new[]
        {
            "IAM_OWNER",
        },
    });

});
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.NewInstanceMember(ctx, "default", &zitadel.InstanceMemberArgs{
			UserId: pulumi.Any(defaultZitadelHumanUser.Id),
			Roles: pulumi.StringArray{
				pulumi.String("IAM_OWNER"),
			},
		})
		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.InstanceMember;
import com.pulumi.zitadel.InstanceMemberArgs;
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 InstanceMember("default", InstanceMemberArgs.builder()        
            .userId(defaultZitadelHumanUser.id())
            .roles("IAM_OWNER")
            .build());

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

const _default = new zitadel.InstanceMember("default", {
    userId: defaultZitadelHumanUser.id,
    roles: ["IAM_OWNER"],
});
Copy
import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.InstanceMember("default",
    user_id=default_zitadel_human_user["id"],
    roles=["IAM_OWNER"])
Copy
resources:
  default:
    type: zitadel:InstanceMember
    properties:
      userId: ${defaultZitadelHumanUser.id}
      roles:
        - IAM_OWNER
Copy

Create InstanceMember Resource

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

Constructor syntax

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

@overload
def InstanceMember(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   roles: Optional[Sequence[str]] = None,
                   user_id: Optional[str] = None)
func NewInstanceMember(ctx *Context, name string, args InstanceMemberArgs, opts ...ResourceOption) (*InstanceMember, error)
public InstanceMember(string name, InstanceMemberArgs args, CustomResourceOptions? opts = null)
public InstanceMember(String name, InstanceMemberArgs args)
public InstanceMember(String name, InstanceMemberArgs args, CustomResourceOptions options)

type: zitadel:InstanceMember
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. InstanceMemberArgs
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. InstanceMemberArgs
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. InstanceMemberArgs
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. InstanceMemberArgs
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. InstanceMemberArgs
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 instanceMemberResource = new Zitadel.InstanceMember("instanceMemberResource", new()
{
    Roles = new[]
    {
        "string",
    },
    UserId = "string",
});
Copy
example, err := zitadel.NewInstanceMember(ctx, "instanceMemberResource", &zitadel.InstanceMemberArgs{
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserId: pulumi.String("string"),
})
Copy
var instanceMemberResource = new InstanceMember("instanceMemberResource", InstanceMemberArgs.builder()
    .roles("string")
    .userId("string")
    .build());
Copy
instance_member_resource = zitadel.InstanceMember("instanceMemberResource",
    roles=["string"],
    user_id="string")
Copy
const instanceMemberResource = new zitadel.InstanceMember("instanceMemberResource", {
    roles: ["string"],
    userId: "string",
});
Copy
type: zitadel:InstanceMember
properties:
    roles:
        - string
    userId: string
Copy

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

Roles This property is required. List<string>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
UserId
This property is required.
Changes to this property will trigger replacement.
string
ID of the user
Roles This property is required. []string
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
UserId
This property is required.
Changes to this property will trigger replacement.
string
ID of the user
roles This property is required. List<String>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId
This property is required.
Changes to this property will trigger replacement.
String
ID of the user
roles This property is required. string[]
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId
This property is required.
Changes to this property will trigger replacement.
string
ID of the user
roles This property is required. Sequence[str]
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
user_id
This property is required.
Changes to this property will trigger replacement.
str
ID of the user
roles This property is required. List<String>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId
This property is required.
Changes to this property will trigger replacement.
String
ID of the user

Outputs

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

Get an existing InstanceMember 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?: InstanceMemberState, opts?: CustomResourceOptions): InstanceMember
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        roles: Optional[Sequence[str]] = None,
        user_id: Optional[str] = None) -> InstanceMember
func GetInstanceMember(ctx *Context, name string, id IDInput, state *InstanceMemberState, opts ...ResourceOption) (*InstanceMember, error)
public static InstanceMember Get(string name, Input<string> id, InstanceMemberState? state, CustomResourceOptions? opts = null)
public static InstanceMember get(String name, Output<String> id, InstanceMemberState state, CustomResourceOptions options)
resources:  _:    type: zitadel:InstanceMember    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:
Roles List<string>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
UserId Changes to this property will trigger replacement. string
ID of the user
Roles []string
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
UserId Changes to this property will trigger replacement. string
ID of the user
roles List<String>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId Changes to this property will trigger replacement. String
ID of the user
roles string[]
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId Changes to this property will trigger replacement. string
ID of the user
roles Sequence[str]
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
user_id Changes to this property will trigger replacement. str
ID of the user
roles List<String>
List of roles granted, full list available here: https://zitadel.com/docs/guides/manage/console/managers#roles
userId Changes to this property will trigger replacement. String
ID of the user

Import

bash The resource can be imported using the ID format <user_id>, e.g.

 $ pulumi import zitadel:index/instanceMember:InstanceMember imported '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