1. Packages
  2. Vercel Provider
  3. API Docs
  4. getProjectMembers
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse

vercel.getProjectMembers

Explore with Pulumi AI

vercel logo
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse

    Retrieves members and their roles for a Vercel Project.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumi/vercel";
    
    const example = vercel.getProject({
        name: "example-with-members",
    });
    const exampleGetProjectMembers = example.then(example => vercel.getProjectMembers({
        projectId: example.id,
    }));
    
    import pulumi
    import pulumi_vercel as vercel
    
    example = vercel.get_project(name="example-with-members")
    example_get_project_members = vercel.get_project_members(project_id=example.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-vercel/sdk/v3/go/vercel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := vercel.LookupProject(ctx, &vercel.LookupProjectArgs{
    			Name: "example-with-members",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = vercel.LookupProjectMembers(ctx, &vercel.LookupProjectMembersArgs{
    			ProjectId: example.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vercel = Pulumi.Vercel;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Vercel.GetProject.Invoke(new()
        {
            Name = "example-with-members",
        });
    
        var exampleGetProjectMembers = Vercel.GetProjectMembers.Invoke(new()
        {
            ProjectId = example.Apply(getProjectResult => getProjectResult.Id),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vercel.VercelFunctions;
    import com.pulumi.vercel.inputs.GetProjectArgs;
    import com.pulumi.vercel.inputs.GetProjectMembersArgs;
    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) {
            final var example = VercelFunctions.getProject(GetProjectArgs.builder()
                .name("example-with-members")
                .build());
    
            final var exampleGetProjectMembers = VercelFunctions.getProjectMembers(GetProjectMembersArgs.builder()
                .projectId(example.applyValue(getProjectResult -> getProjectResult.id()))
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: vercel:getProject
          Arguments:
            name: example-with-members
      exampleGetProjectMembers:
        fn::invoke:
          Function: vercel:getProjectMembers
          Arguments:
            projectId: ${example.id}
    

    Using getProjectMembers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProjectMembers(args: GetProjectMembersArgs, opts?: InvokeOptions): Promise<GetProjectMembersResult>
    function getProjectMembersOutput(args: GetProjectMembersOutputArgs, opts?: InvokeOptions): Output<GetProjectMembersResult>
    def get_project_members(project_id: Optional[str] = None,
                            team_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetProjectMembersResult
    def get_project_members_output(project_id: Optional[pulumi.Input[str]] = None,
                            team_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetProjectMembersResult]
    func LookupProjectMembers(ctx *Context, args *LookupProjectMembersArgs, opts ...InvokeOption) (*LookupProjectMembersResult, error)
    func LookupProjectMembersOutput(ctx *Context, args *LookupProjectMembersOutputArgs, opts ...InvokeOption) LookupProjectMembersResultOutput

    > Note: This function is named LookupProjectMembers in the Go SDK.

    public static class GetProjectMembers 
    {
        public static Task<GetProjectMembersResult> InvokeAsync(GetProjectMembersArgs args, InvokeOptions? opts = null)
        public static Output<GetProjectMembersResult> Invoke(GetProjectMembersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetProjectMembersResult> getProjectMembers(GetProjectMembersArgs args, InvokeOptions options)
    public static Output<GetProjectMembersResult> getProjectMembers(GetProjectMembersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vercel:index/getProjectMembers:getProjectMembers
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProjectId string
    The ID of the Vercel Project.
    TeamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    ProjectId string
    The ID of the Vercel Project.
    TeamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    projectId String
    The ID of the Vercel Project.
    teamId String
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    projectId string
    The ID of the Vercel Project.
    teamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    project_id str
    The ID of the Vercel Project.
    team_id str
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    projectId String
    The ID of the Vercel Project.
    teamId String
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.

    getProjectMembers Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Members List<Pulumiverse.Vercel.Outputs.GetProjectMembersMember>
    The set of members in this project.
    ProjectId string
    The ID of the Vercel Project.
    TeamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    Members []GetProjectMembersMember
    The set of members in this project.
    ProjectId string
    The ID of the Vercel Project.
    TeamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<GetProjectMembersMember>
    The set of members in this project.
    projectId String
    The ID of the Vercel Project.
    teamId String
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    id string
    The provider-assigned unique ID for this managed resource.
    members GetProjectMembersMember[]
    The set of members in this project.
    projectId string
    The ID of the Vercel Project.
    teamId string
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    id str
    The provider-assigned unique ID for this managed resource.
    members Sequence[GetProjectMembersMember]
    The set of members in this project.
    project_id str
    The ID of the Vercel Project.
    team_id str
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.
    id String
    The provider-assigned unique ID for this managed resource.
    members List<Property Map>
    The set of members in this project.
    projectId String
    The ID of the Vercel Project.
    teamId String
    The team ID to which the project belongs. Required when accessing a team project if a default team has not been set in the provider.

    Supporting Types

    GetProjectMembersMember

    Email string
    The email of the user.
    Role string
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    UserId string
    The ID of the user.
    Username string
    The username of the user.
    Email string
    The email of the user.
    Role string
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    UserId string
    The ID of the user.
    Username string
    The username of the user.
    email String
    The email of the user.
    role String
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    userId String
    The ID of the user.
    username String
    The username of the user.
    email string
    The email of the user.
    role string
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    userId string
    The ID of the user.
    username string
    The username of the user.
    email str
    The email of the user.
    role str
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    user_id str
    The ID of the user.
    username str
    The username of the user.
    email String
    The email of the user.
    role String
    The role of the user in the project. One of 'MEMBER', 'PROJECTDEVELOPER', or 'PROJECTVIEWER'.
    userId String
    The ID of the user.
    username String
    The username of the user.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse