1. Packages
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. AccessGroupMember
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse
vercel logo
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse

    Provides an Access Group Member Resource.

    An Access Group Member resource defines the membership of a Vercel user (by their user ID) in a vercel.AccessGroup.

    Access group membership can also be managed through the access_groups attribute of the vercel.TeamMember resource. Do not manage the same user’s membership of the same access group with both resources, as they will conflict and produce a perpetual diff.

    For more detailed information, please see the Vercel documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const example = new vercel.AccessGroup("example", {
        teamId: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
        name: "example-access-group",
    });
    const exampleAccessGroupMember = new vercel.AccessGroupMember("example", {
        teamId: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
        accessGroupId: example.id,
        userId: "uuuuuuuuuuuuuuuuuuuuuuuuuu",
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    example = vercel.AccessGroup("example",
        team_id="team_xxxxxxxxxxxxxxxxxxxxxxxx",
        name="example-access-group")
    example_access_group_member = vercel.AccessGroupMember("example",
        team_id="team_xxxxxxxxxxxxxxxxxxxxxxxx",
        access_group_id=example.id,
        user_id="uuuuuuuuuuuuuuuuuuuuuuuuuu")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-vercel/sdk/v5/go/vercel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := vercel.NewAccessGroup(ctx, "example", &vercel.AccessGroupArgs{
    			TeamId: pulumi.String("team_xxxxxxxxxxxxxxxxxxxxxxxx"),
    			Name:   pulumi.String("example-access-group"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vercel.NewAccessGroupMember(ctx, "example", &vercel.AccessGroupMemberArgs{
    			TeamId:        pulumi.String("team_xxxxxxxxxxxxxxxxxxxxxxxx"),
    			AccessGroupId: example.ID(),
    			UserId:        pulumi.String("uuuuuuuuuuuuuuuuuuuuuuuuuu"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vercel = Pulumiverse.Vercel;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Vercel.AccessGroup("example", new()
        {
            TeamId = "team_xxxxxxxxxxxxxxxxxxxxxxxx",
            Name = "example-access-group",
        });
    
        var exampleAccessGroupMember = new Vercel.AccessGroupMember("example", new()
        {
            TeamId = "team_xxxxxxxxxxxxxxxxxxxxxxxx",
            AccessGroupId = example.Id,
            UserId = "uuuuuuuuuuuuuuuuuuuuuuuuuu",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.vercel.AccessGroup;
    import com.pulumiverse.vercel.AccessGroupArgs;
    import com.pulumiverse.vercel.AccessGroupMember;
    import com.pulumiverse.vercel.AccessGroupMemberArgs;
    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 example = new AccessGroup("example", AccessGroupArgs.builder()
                .teamId("team_xxxxxxxxxxxxxxxxxxxxxxxx")
                .name("example-access-group")
                .build());
    
            var exampleAccessGroupMember = new AccessGroupMember("exampleAccessGroupMember", AccessGroupMemberArgs.builder()
                .teamId("team_xxxxxxxxxxxxxxxxxxxxxxxx")
                .accessGroupId(example.id())
                .userId("uuuuuuuuuuuuuuuuuuuuuuuuuu")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vercel:AccessGroup
        properties:
          teamId: team_xxxxxxxxxxxxxxxxxxxxxxxx
          name: example-access-group
      exampleAccessGroupMember:
        type: vercel:AccessGroupMember
        name: example
        properties:
          teamId: team_xxxxxxxxxxxxxxxxxxxxxxxx
          accessGroupId: ${example.id}
          userId: uuuuuuuuuuuuuuuuuuuuuuuuuu
    
    Example coming soon!
    

    Create AccessGroupMember Resource

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

    Constructor syntax

    new AccessGroupMember(name: string, args: AccessGroupMemberArgs, opts?: CustomResourceOptions);
    @overload
    def AccessGroupMember(resource_name: str,
                          args: AccessGroupMemberArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessGroupMember(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          access_group_id: Optional[str] = None,
                          user_id: Optional[str] = None,
                          team_id: Optional[str] = None)
    func NewAccessGroupMember(ctx *Context, name string, args AccessGroupMemberArgs, opts ...ResourceOption) (*AccessGroupMember, error)
    public AccessGroupMember(string name, AccessGroupMemberArgs args, CustomResourceOptions? opts = null)
    public AccessGroupMember(String name, AccessGroupMemberArgs args)
    public AccessGroupMember(String name, AccessGroupMemberArgs args, CustomResourceOptions options)
    
    type: vercel:AccessGroupMember
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vercel_access_group_member" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AccessGroupMemberArgs
    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 AccessGroupMemberArgs
    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 AccessGroupMemberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessGroupMemberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessGroupMemberArgs
    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 accessGroupMemberResource = new Vercel.AccessGroupMember("accessGroupMemberResource", new()
    {
        AccessGroupId = "string",
        UserId = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewAccessGroupMember(ctx, "accessGroupMemberResource", &vercel.AccessGroupMemberArgs{
    	AccessGroupId: pulumi.String("string"),
    	UserId:        pulumi.String("string"),
    	TeamId:        pulumi.String("string"),
    })
    
    resource "vercel_access_group_member" "accessGroupMemberResource" {
      lifecycle {
        create_before_destroy = true
      }
      access_group_id = "string"
      user_id         = "string"
      team_id         = "string"
    }
    
    var accessGroupMemberResource = new AccessGroupMember("accessGroupMemberResource", AccessGroupMemberArgs.builder()
        .accessGroupId("string")
        .userId("string")
        .teamId("string")
        .build());
    
    access_group_member_resource = vercel.AccessGroupMember("accessGroupMemberResource",
        access_group_id="string",
        user_id="string",
        team_id="string")
    
    const accessGroupMemberResource = new vercel.AccessGroupMember("accessGroupMemberResource", {
        accessGroupId: "string",
        userId: "string",
        teamId: "string",
    });
    
    type: vercel:AccessGroupMember
    properties:
        accessGroupId: string
        teamId: string
        userId: string
    

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

    AccessGroupId string
    The ID of the Access Group.
    UserId string
    The ID of the user to add to the access group.
    TeamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    AccessGroupId string
    The ID of the Access Group.
    UserId string
    The ID of the user to add to the access group.
    TeamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access_group_id string
    The ID of the Access Group.
    user_id string
    The ID of the user to add to the access group.
    team_id string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    userId String
    The ID of the user to add to the access group.
    teamId String
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId string
    The ID of the Access Group.
    userId string
    The ID of the user to add to the access group.
    teamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access_group_id str
    The ID of the Access Group.
    user_id str
    The ID of the user to add to the access group.
    team_id str
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    accessGroupId String
    The ID of the Access Group.
    userId String
    The ID of the user to add to the access group.
    teamId String
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

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

    Get an existing AccessGroupMember 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?: AccessGroupMemberState, opts?: CustomResourceOptions): AccessGroupMember
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_group_id: Optional[str] = None,
            team_id: Optional[str] = None,
            user_id: Optional[str] = None) -> AccessGroupMember
    func GetAccessGroupMember(ctx *Context, name string, id IDInput, state *AccessGroupMemberState, opts ...ResourceOption) (*AccessGroupMember, error)
    public static AccessGroupMember Get(string name, Input<string> id, AccessGroupMemberState? state, CustomResourceOptions? opts = null)
    public static AccessGroupMember get(String name, Output<String> id, AccessGroupMemberState state, CustomResourceOptions options)
    resources:  _:    type: vercel:AccessGroupMember    get:      id: ${id}
    import {
      to = vercel_access_group_member.example
      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:
    AccessGroupId string
    The ID of the Access Group.
    TeamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    UserId string
    The ID of the user to add to the access group.
    AccessGroupId string
    The ID of the Access Group.
    TeamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    UserId string
    The ID of the user to add to the access group.
    access_group_id string
    The ID of the Access Group.
    team_id string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    user_id string
    The ID of the user to add to the access group.
    accessGroupId String
    The ID of the Access Group.
    teamId String
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    userId String
    The ID of the user to add to the access group.
    accessGroupId string
    The ID of the Access Group.
    teamId string
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    userId string
    The ID of the user to add to the access group.
    access_group_id str
    The ID of the Access Group.
    team_id str
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    user_id str
    The ID of the user to add to the access group.
    accessGroupId String
    The ID of the Access Group.
    teamId String
    The ID of the team the access group member should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    userId String
    The ID of the user to add to the access group.

    Import

    The pulumi import command can be used, for example:

    If importing into a personal account, or with a team configured on the provider, use the access_group_id and user_id.

    $ pulumi import vercel:index/accessGroupMember:AccessGroupMember example ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxx
    

    If importing to a team, use the team_id, access_group_id and user_id.

    $ pulumi import vercel:index/accessGroupMember:AccessGroupMember example team_xxxxxxxxxxxxxxxxxxxxxxxx/ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxx
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Viewing docs for Vercel v5.4.1
    published on Wednesday, Jul 22, 2026 by Pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial