Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel Provider
  3. API Docs
  4. getTeamConfig
Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.getTeamConfig

Explore with Pulumi AI

vercel logo
Vercel v3.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

    Retrieves the configuration of an existing Vercel Team.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vercel from "@pulumi/vercel";

const example = vercel.getTeamConfig({
    id: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
});

    import pulumi
import pulumi_vercel as vercel

example = vercel.get_team_config(id="team_xxxxxxxxxxxxxxxxxxxxxxxx")

    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 {
		_, err := vercel.LookupTeamConfig(ctx, &vercel.LookupTeamConfigArgs{
			Id: "team_xxxxxxxxxxxxxxxxxxxxxxxx",
		}, 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.GetTeamConfig.Invoke(new()
    {
        Id = "team_xxxxxxxxxxxxxxxxxxxxxxxx",
    });

});

    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.GetTeamConfigArgs;
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.getTeamConfig(GetTeamConfigArgs.builder()
            .id("team_xxxxxxxxxxxxxxxxxxxxxxxx")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: vercel:getTeamConfig
      Arguments:
        id: team_xxxxxxxxxxxxxxxxxxxxxxxx

    Using getTeamConfig

    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 getTeamConfig(args: GetTeamConfigArgs, opts?: InvokeOptions): Promise<GetTeamConfigResult>
function getTeamConfigOutput(args: GetTeamConfigOutputArgs, opts?: InvokeOptions): Output<GetTeamConfigResult>
    def get_team_config(id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetTeamConfigResult
def get_team_config_output(id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetTeamConfigResult]
    func LookupTeamConfig(ctx *Context, args *LookupTeamConfigArgs, opts ...InvokeOption) (*LookupTeamConfigResult, error)
func LookupTeamConfigOutput(ctx *Context, args *LookupTeamConfigOutputArgs, opts ...InvokeOption) LookupTeamConfigResultOutput

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

    public static class GetTeamConfig 
{
    public static Task<GetTeamConfigResult> InvokeAsync(GetTeamConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetTeamConfigResult> Invoke(GetTeamConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTeamConfigResult> getTeamConfig(GetTeamConfigArgs args, InvokeOptions options)
public static Output<GetTeamConfigResult> getTeamConfig(GetTeamConfigArgs args, InvokeOptions options)

    fn::invoke:
  function: vercel:index/getTeamConfig:getTeamConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of the existing Vercel Team.
    Id string
    The ID of the existing Vercel Team.
    id String
    The ID of the existing Vercel Team.
    id string
    The ID of the existing Vercel Team.
    id str
    The ID of the existing Vercel Team.
    id String
    The ID of the existing Vercel Team.

    getTeamConfig Result

    The following output properties are available:

    Description string
    A description of the team.
    EmailDomain string
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    EnablePreviewFeedback string
    Preview feedback configuration.
    EnableProductionFeedback string
    Production feedback configuration.
    HideIpAddresses bool
    Indicates if ip addresses should be accessible in o11y tooling.
    HideIpAddressesInLogDrains bool
    Indicates if ip addresses should be accessible in log drains.
    Id string
    The ID of the existing Vercel Team.
    InviteCode string
    A code that can be used to join this team. Only visible to Team owners.
    Name string
    The name of the team.
    PreviewDeploymentSuffix string
    The hostname that is used as the preview deployment suffix.
    RemoteCaching Pulumiverse.Vercel.Outputs.GetTeamConfigRemoteCaching
    Configuration for Remote Caching.
    Saml Pulumiverse.Vercel.Outputs.GetTeamConfigSaml
    Configuration for SAML authentication.
    SensitiveEnvironmentVariablePolicy string
    The policy for sensitive environment variables.
    Slug string
    The slug of the team. Used in the URL of the team's dashboard.
    Description string
    A description of the team.
    EmailDomain string
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    EnablePreviewFeedback string
    Preview feedback configuration.
    EnableProductionFeedback string
    Production feedback configuration.
    HideIpAddresses bool
    Indicates if ip addresses should be accessible in o11y tooling.
    HideIpAddressesInLogDrains bool
    Indicates if ip addresses should be accessible in log drains.
    Id string
    The ID of the existing Vercel Team.
    InviteCode string
    A code that can be used to join this team. Only visible to Team owners.
    Name string
    The name of the team.
    PreviewDeploymentSuffix string
    The hostname that is used as the preview deployment suffix.
    RemoteCaching GetTeamConfigRemoteCaching
    Configuration for Remote Caching.
    Saml GetTeamConfigSaml
    Configuration for SAML authentication.
    SensitiveEnvironmentVariablePolicy string
    The policy for sensitive environment variables.
    Slug string
    The slug of the team. Used in the URL of the team's dashboard.
    description String
    A description of the team.
    emailDomain String
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    enablePreviewFeedback String
    Preview feedback configuration.
    enableProductionFeedback String
    Production feedback configuration.
    hideIpAddresses Boolean
    Indicates if ip addresses should be accessible in o11y tooling.
    hideIpAddressesInLogDrains Boolean
    Indicates if ip addresses should be accessible in log drains.
    id String
    The ID of the existing Vercel Team.
    inviteCode String
    A code that can be used to join this team. Only visible to Team owners.
    name String
    The name of the team.
    previewDeploymentSuffix String
    The hostname that is used as the preview deployment suffix.
    remoteCaching GetTeamConfigRemoteCaching
    Configuration for Remote Caching.
    saml GetTeamConfigSaml
    Configuration for SAML authentication.
    sensitiveEnvironmentVariablePolicy String
    The policy for sensitive environment variables.
    slug String
    The slug of the team. Used in the URL of the team's dashboard.
    description string
    A description of the team.
    emailDomain string
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    enablePreviewFeedback string
    Preview feedback configuration.
    enableProductionFeedback string
    Production feedback configuration.
    hideIpAddresses boolean
    Indicates if ip addresses should be accessible in o11y tooling.
    hideIpAddressesInLogDrains boolean
    Indicates if ip addresses should be accessible in log drains.
    id string
    The ID of the existing Vercel Team.
    inviteCode string
    A code that can be used to join this team. Only visible to Team owners.
    name string
    The name of the team.
    previewDeploymentSuffix string
    The hostname that is used as the preview deployment suffix.
    remoteCaching GetTeamConfigRemoteCaching
    Configuration for Remote Caching.
    saml GetTeamConfigSaml
    Configuration for SAML authentication.
    sensitiveEnvironmentVariablePolicy string
    The policy for sensitive environment variables.
    slug string
    The slug of the team. Used in the URL of the team's dashboard.
    description str
    A description of the team.
    email_domain str
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    enable_preview_feedback str
    Preview feedback configuration.
    enable_production_feedback str
    Production feedback configuration.
    hide_ip_addresses bool
    Indicates if ip addresses should be accessible in o11y tooling.
    hide_ip_addresses_in_log_drains bool
    Indicates if ip addresses should be accessible in log drains.
    id str
    The ID of the existing Vercel Team.
    invite_code str
    A code that can be used to join this team. Only visible to Team owners.
    name str
    The name of the team.
    preview_deployment_suffix str
    The hostname that is used as the preview deployment suffix.
    remote_caching GetTeamConfigRemoteCaching
    Configuration for Remote Caching.
    saml GetTeamConfigSaml
    Configuration for SAML authentication.
    sensitive_environment_variable_policy str
    The policy for sensitive environment variables.
    slug str
    The slug of the team. Used in the URL of the team's dashboard.
    description String
    A description of the team.
    emailDomain String
    Hostname that'll be matched with emails on sign-up to automatically join the Team.
    enablePreviewFeedback String
    Preview feedback configuration.
    enableProductionFeedback String
    Production feedback configuration.
    hideIpAddresses Boolean
    Indicates if ip addresses should be accessible in o11y tooling.
    hideIpAddressesInLogDrains Boolean
    Indicates if ip addresses should be accessible in log drains.
    id String
    The ID of the existing Vercel Team.
    inviteCode String
    A code that can be used to join this team. Only visible to Team owners.
    name String
    The name of the team.
    previewDeploymentSuffix String
    The hostname that is used as the preview deployment suffix.
    remoteCaching Property Map
    Configuration for Remote Caching.
    saml Property Map
    Configuration for SAML authentication.
    sensitiveEnvironmentVariablePolicy String
    The policy for sensitive environment variables.
    slug String
    The slug of the team. Used in the URL of the team's dashboard.

    Supporting Types

    GetTeamConfigRemoteCaching

    Enabled bool
    Indicates if Remote Caching is enabled.
    Enabled bool
    Indicates if Remote Caching is enabled.
    enabled Boolean
    Indicates if Remote Caching is enabled.
    enabled boolean
    Indicates if Remote Caching is enabled.
    enabled bool
    Indicates if Remote Caching is enabled.
    enabled Boolean
    Indicates if Remote Caching is enabled.

    GetTeamConfigSaml

    Enforced bool
    Indicates if SAML is enforced for the team.
    Roles Dictionary<string, Pulumiverse.Vercel.Inputs.GetTeamConfigSamlRoles>
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.
    Enforced bool
    Indicates if SAML is enforced for the team.
    Roles map[string]GetTeamConfigSamlRoles
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.
    enforced Boolean
    Indicates if SAML is enforced for the team.
    roles Map<String,GetTeamConfigSamlRoles>
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.
    enforced boolean
    Indicates if SAML is enforced for the team.
    roles {[key: string]: GetTeamConfigSamlRoles}
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.
    enforced bool
    Indicates if SAML is enforced for the team.
    roles Mapping[str, GetTeamConfigSamlRoles]
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.
    enforced Boolean
    Indicates if SAML is enforced for the team.
    roles Map<Property Map>
    Directory groups to role or access group mappings. For each directory group, either a role or access group id is specified.

    GetTeamConfigSamlRoles

    AccessGroupId string
    The access group the assign is assigned to.
    Role string
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.
    AccessGroupId string
    The access group the assign is assigned to.
    Role string
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.
    accessGroupId String
    The access group the assign is assigned to.
    role String
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.
    accessGroupId string
    The access group the assign is assigned to.
    role string
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.
    access_group_id str
    The access group the assign is assigned to.
    role str
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.
    accessGroupId String
    The access group the assign is assigned to.
    role String
    The team level role the user is assigned. One of 'MEMBER', 'OWNER', 'VIEWER', 'DEVELOPER', 'BILLING' or 'CONTRIBUTOR'.

    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.2.1 published on Wednesday, May 14, 2025 by Pulumiverse
    pulumiverse/pulumi-vercel