Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthUserGroupMembership
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthUserGroupMembership

Explore with Pulumi AI

fusionauth logo
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

    # User Group Membership Resource

    User Group Membership API

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const _this = new fusionauth.FusionAuthUserGroupMembership("this", {
    groupId: fusionauth_group["this"].id,
    userId: fusionauth_user["this"].id,
});

    import pulumi
import theogravity_pulumi_fusionauth as fusionauth

this = fusionauth.FusionAuthUserGroupMembership("this",
    group_id=fusionauth_group["this"]["id"],
    user_id=fusionauth_user["this"]["id"])

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthUserGroupMembership(ctx, "this", &fusionauth.FusionAuthUserGroupMembershipArgs{
			GroupId: pulumi.Any(fusionauth_group.This.Id),
			UserId:  pulumi.Any(fusionauth_user.This.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var @this = new Fusionauth.FusionAuthUserGroupMembership("this", new()
    {
        GroupId = fusionauth_group.This.Id,
        UserId = fusionauth_user.This.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthUserGroupMembership;
import com.pulumi.fusionauth.FusionAuthUserGroupMembershipArgs;
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 this_ = new FusionAuthUserGroupMembership("this", FusionAuthUserGroupMembershipArgs.builder()
            .groupId(fusionauth_group.this().id())
            .userId(fusionauth_user.this().id())
            .build());

    }
}

    resources:
  this:
    type: fusionauth:FusionAuthUserGroupMembership
    properties:
      groupId: ${fusionauth_group.this.id}
      userId: ${fusionauth_user.this.id}

    Create FusionAuthUserGroupMembership Resource

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

    Constructor syntax

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

@overload
def FusionAuthUserGroupMembership(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  group_id: Optional[str] = None,
                                  user_id: Optional[str] = None,
                                  data: Optional[Mapping[str, str]] = None,
                                  membership_id: Optional[str] = None)
    func NewFusionAuthUserGroupMembership(ctx *Context, name string, args FusionAuthUserGroupMembershipArgs, opts ...ResourceOption) (*FusionAuthUserGroupMembership, error)
    public FusionAuthUserGroupMembership(string name, FusionAuthUserGroupMembershipArgs args, CustomResourceOptions? opts = null)
    public FusionAuthUserGroupMembership(String name, FusionAuthUserGroupMembershipArgs args)
public FusionAuthUserGroupMembership(String name, FusionAuthUserGroupMembershipArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthUserGroupMembership
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 FusionAuthUserGroupMembershipArgs
    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 FusionAuthUserGroupMembershipArgs
    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 FusionAuthUserGroupMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthUserGroupMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthUserGroupMembershipArgs
    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 fusionAuthUserGroupMembershipResource = new Fusionauth.FusionAuthUserGroupMembership("fusionAuthUserGroupMembershipResource", new()
{
    GroupId = "string",
    UserId = "string",
    Data = 
    {
        { "string", "string" },
    },
    MembershipId = "string",
});

    example, err := fusionauth.NewFusionAuthUserGroupMembership(ctx, "fusionAuthUserGroupMembershipResource", &fusionauth.FusionAuthUserGroupMembershipArgs{
	GroupId: pulumi.String("string"),
	UserId:  pulumi.String("string"),
	Data: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	MembershipId: pulumi.String("string"),
})

    var fusionAuthUserGroupMembershipResource = new FusionAuthUserGroupMembership("fusionAuthUserGroupMembershipResource", FusionAuthUserGroupMembershipArgs.builder()
    .groupId("string")
    .userId("string")
    .data(Map.of("string", "string"))
    .membershipId("string")
    .build());

    fusion_auth_user_group_membership_resource = fusionauth.FusionAuthUserGroupMembership("fusionAuthUserGroupMembershipResource",
    group_id="string",
    user_id="string",
    data={
        "string": "string",
    },
    membership_id="string")

    const fusionAuthUserGroupMembershipResource = new fusionauth.FusionAuthUserGroupMembership("fusionAuthUserGroupMembershipResource", {
    groupId: "string",
    userId: "string",
    data: {
        string: "string",
    },
    membershipId: "string",
});

    type: fusionauth:FusionAuthUserGroupMembership
properties:
    data:
        string: string
    groupId: string
    membershipId: string
    userId: string

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

    GroupId string
    The Id of the Group of this membership.
    UserId string
    "The Id of the User of this membership.
    Data Dictionary<string, string>
    An object that can hold any information about the User for this membership that should be persisted.
    MembershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    GroupId string
    The Id of the Group of this membership.
    UserId string
    "The Id of the User of this membership.
    Data map[string]string
    An object that can hold any information about the User for this membership that should be persisted.
    MembershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    groupId String
    The Id of the Group of this membership.
    userId String
    "The Id of the User of this membership.
    data Map<String,String>
    An object that can hold any information about the User for this membership that should be persisted.
    membershipId String
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    groupId string
    The Id of the Group of this membership.
    userId string
    "The Id of the User of this membership.
    data {[key: string]: string}
    An object that can hold any information about the User for this membership that should be persisted.
    membershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    group_id str
    The Id of the Group of this membership.
    user_id str
    "The Id of the User of this membership.
    data Mapping[str, str]
    An object that can hold any information about the User for this membership that should be persisted.
    membership_id str
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    groupId String
    The Id of the Group of this membership.
    userId String
    "The Id of the User of this membership.
    data Map<String>
    An object that can hold any information about the User for this membership that should be persisted.
    membershipId String
    The Id of the User Group Membership. If not provided, a random UUID will be generated.

    Outputs

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

    Get an existing FusionAuthUserGroupMembership 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?: FusionAuthUserGroupMembershipState, opts?: CustomResourceOptions): FusionAuthUserGroupMembership
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data: Optional[Mapping[str, str]] = None,
        group_id: Optional[str] = None,
        membership_id: Optional[str] = None,
        user_id: Optional[str] = None) -> FusionAuthUserGroupMembership
    func GetFusionAuthUserGroupMembership(ctx *Context, name string, id IDInput, state *FusionAuthUserGroupMembershipState, opts ...ResourceOption) (*FusionAuthUserGroupMembership, error)
    public static FusionAuthUserGroupMembership Get(string name, Input<string> id, FusionAuthUserGroupMembershipState? state, CustomResourceOptions? opts = null)
    public static FusionAuthUserGroupMembership get(String name, Output<String> id, FusionAuthUserGroupMembershipState state, CustomResourceOptions options)
    resources:  _:    type: fusionauth:FusionAuthUserGroupMembership    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:
    Data Dictionary<string, string>
    An object that can hold any information about the User for this membership that should be persisted.
    GroupId string
    The Id of the Group of this membership.
    MembershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    UserId string
    "The Id of the User of this membership.
    Data map[string]string
    An object that can hold any information about the User for this membership that should be persisted.
    GroupId string
    The Id of the Group of this membership.
    MembershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    UserId string
    "The Id of the User of this membership.
    data Map<String,String>
    An object that can hold any information about the User for this membership that should be persisted.
    groupId String
    The Id of the Group of this membership.
    membershipId String
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    userId String
    "The Id of the User of this membership.
    data {[key: string]: string}
    An object that can hold any information about the User for this membership that should be persisted.
    groupId string
    The Id of the Group of this membership.
    membershipId string
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    userId string
    "The Id of the User of this membership.
    data Mapping[str, str]
    An object that can hold any information about the User for this membership that should be persisted.
    group_id str
    The Id of the Group of this membership.
    membership_id str
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    user_id str
    "The Id of the User of this membership.
    data Map<String>
    An object that can hold any information about the User for this membership that should be persisted.
    groupId String
    The Id of the Group of this membership.
    membershipId String
    The Id of the User Group Membership. If not provided, a random UUID will be generated.
    userId String
    "The Id of the User of this membership.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
    theogravity/pulumi-fusionauth