Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Fivetran Provider
  3. API Docs
  4. User
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

fivetran.User

Explore with Pulumi AI

fivetran logo
fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
fivetran/terraform-provider-fivetran

    -This resource allows you to create, update, and delete users.

    Example Usage

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

const user = new fivetran.User("user", {
    email: "user@email.address.com",
    familyName: "Doe",
    givenName: "John",
    phone: "+353 00 0000 0000",
});

    import pulumi
import pulumi_fivetran as fivetran

user = fivetran.User("user",
    email="user@email.address.com",
    family_name="Doe",
    given_name="John",
    phone="+353 00 0000 0000")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.NewUser(ctx, "user", &fivetran.UserArgs{
			Email:      pulumi.String("user@email.address.com"),
			FamilyName: pulumi.String("Doe"),
			GivenName:  pulumi.String("John"),
			Phone:      pulumi.String("+353 00 0000 0000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var user = new Fivetran.User("user", new()
    {
        Email = "user@email.address.com",
        FamilyName = "Doe",
        GivenName = "John",
        Phone = "+353 00 0000 0000",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.User;
import com.pulumi.fivetran.UserArgs;
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 user = new User("user", UserArgs.builder()
            .email("user@email.address.com")
            .familyName("Doe")
            .givenName("John")
            .phone("+353 00 0000 0000")
            .build());

    }
}

    resources:
  user:
    type: fivetran:User
    properties:
      email: user@email.address.com
      familyName: Doe
      givenName: John
      phone: +353 00 0000 0000

    Create User Resource

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

    Constructor syntax

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

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         email: Optional[str] = None,
         family_name: Optional[str] = None,
         given_name: Optional[str] = None,
         invited: Optional[bool] = None,
         phone: Optional[str] = None,
         picture: Optional[str] = None,
         role: Optional[str] = None,
         verified: Optional[bool] = None)
    func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
    public User(string name, UserArgs args, CustomResourceOptions? opts = null)
    public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

    type: fivetran:User
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 UserArgs
    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 UserArgs
    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 UserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserArgs
    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 userResource = new Fivetran.User("userResource", new()
{
    Email = "string",
    FamilyName = "string",
    GivenName = "string",
    Invited = false,
    Phone = "string",
    Picture = "string",
    Role = "string",
    Verified = false,
});

    example, err := fivetran.NewUser(ctx, "userResource", &fivetran.UserArgs{
Email: pulumi.String("string"),
FamilyName: pulumi.String("string"),
GivenName: pulumi.String("string"),
Invited: pulumi.Bool(false),
Phone: pulumi.String("string"),
Picture: pulumi.String("string"),
Role: pulumi.String("string"),
Verified: pulumi.Bool(false),
})

    var userResource = new User("userResource", UserArgs.builder()
    .email("string")
    .familyName("string")
    .givenName("string")
    .invited(false)
    .phone("string")
    .picture("string")
    .role("string")
    .verified(false)
    .build());

    user_resource = fivetran.User("userResource",
    email="string",
    family_name="string",
    given_name="string",
    invited=False,
    phone="string",
    picture="string",
    role="string",
    verified=False)

    const userResource = new fivetran.User("userResource", {
    email: "string",
    familyName: "string",
    givenName: "string",
    invited: false,
    phone: "string",
    picture: "string",
    role: "string",
    verified: false,
});

    type: fivetran:User
properties:
    email: string
    familyName: string
    givenName: string
    invited: false
    phone: string
    picture: string
    role: string
    verified: false

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

    Email string
    The email address that the user has associated with their user profile.
    FamilyName string
    The last name of the user.
    GivenName string
    The first name of the user.
    Invited bool
    The field indicates whether the user has been invited to your account.
    Phone string
    The phone number of the user.
    Picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    Role string
    The role that you would like to assign to the user.
    Verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    Email string
    The email address that the user has associated with their user profile.
    FamilyName string
    The last name of the user.
    GivenName string
    The first name of the user.
    Invited bool
    The field indicates whether the user has been invited to your account.
    Phone string
    The phone number of the user.
    Picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    Role string
    The role that you would like to assign to the user.
    Verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    email String
    The email address that the user has associated with their user profile.
    familyName String
    The last name of the user.
    givenName String
    The first name of the user.
    invited Boolean
    The field indicates whether the user has been invited to your account.
    phone String
    The phone number of the user.
    picture String
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role String
    The role that you would like to assign to the user.
    verified Boolean
    The field indicates whether the user has verified their email address in the account creation process.
    email string
    The email address that the user has associated with their user profile.
    familyName string
    The last name of the user.
    givenName string
    The first name of the user.
    invited boolean
    The field indicates whether the user has been invited to your account.
    phone string
    The phone number of the user.
    picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role string
    The role that you would like to assign to the user.
    verified boolean
    The field indicates whether the user has verified their email address in the account creation process.
    email str
    The email address that the user has associated with their user profile.
    family_name str
    The last name of the user.
    given_name str
    The first name of the user.
    invited bool
    The field indicates whether the user has been invited to your account.
    phone str
    The phone number of the user.
    picture str
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role str
    The role that you would like to assign to the user.
    verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    email String
    The email address that the user has associated with their user profile.
    familyName String
    The last name of the user.
    givenName String
    The first name of the user.
    invited Boolean
    The field indicates whether the user has been invited to your account.
    phone String
    The phone number of the user.
    picture String
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role String
    The role that you would like to assign to the user.
    verified Boolean
    The field indicates whether the user has verified their email address in the account creation process.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

    CreatedAt string
    The timestamp that the user created their Fivetran account.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoggedInAt string
    The last time that the user has logged into their Fivetran account.
    CreatedAt string
    The timestamp that the user created their Fivetran account.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoggedInAt string
    The last time that the user has logged into their Fivetran account.
    createdAt String
    The timestamp that the user created their Fivetran account.
    id String
    The provider-assigned unique ID for this managed resource.
    loggedInAt String
    The last time that the user has logged into their Fivetran account.
    createdAt string
    The timestamp that the user created their Fivetran account.
    id string
    The provider-assigned unique ID for this managed resource.
    loggedInAt string
    The last time that the user has logged into their Fivetran account.
    created_at str
    The timestamp that the user created their Fivetran account.
    id str
    The provider-assigned unique ID for this managed resource.
    logged_in_at str
    The last time that the user has logged into their Fivetran account.
    createdAt String
    The timestamp that the user created their Fivetran account.
    id String
    The provider-assigned unique ID for this managed resource.
    loggedInAt String
    The last time that the user has logged into their Fivetran account.

    Look up Existing User Resource

    Get an existing User 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?: UserState, opts?: CustomResourceOptions): User
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        email: Optional[str] = None,
        family_name: Optional[str] = None,
        given_name: Optional[str] = None,
        invited: Optional[bool] = None,
        logged_in_at: Optional[str] = None,
        phone: Optional[str] = None,
        picture: Optional[str] = None,
        role: Optional[str] = None,
        verified: Optional[bool] = None) -> User
    func GetUser(ctx *Context, name string, id IDInput, state *UserState, opts ...ResourceOption) (*User, error)
    public static User Get(string name, Input<string> id, UserState? state, CustomResourceOptions? opts = null)
    public static User get(String name, Output<String> id, UserState state, CustomResourceOptions options)
    resources:  _:    type: fivetran:User    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:
    CreatedAt string
    The timestamp that the user created their Fivetran account.
    Email string
    The email address that the user has associated with their user profile.
    FamilyName string
    The last name of the user.
    GivenName string
    The first name of the user.
    Invited bool
    The field indicates whether the user has been invited to your account.
    LoggedInAt string
    The last time that the user has logged into their Fivetran account.
    Phone string
    The phone number of the user.
    Picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    Role string
    The role that you would like to assign to the user.
    Verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    CreatedAt string
    The timestamp that the user created their Fivetran account.
    Email string
    The email address that the user has associated with their user profile.
    FamilyName string
    The last name of the user.
    GivenName string
    The first name of the user.
    Invited bool
    The field indicates whether the user has been invited to your account.
    LoggedInAt string
    The last time that the user has logged into their Fivetran account.
    Phone string
    The phone number of the user.
    Picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    Role string
    The role that you would like to assign to the user.
    Verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    createdAt String
    The timestamp that the user created their Fivetran account.
    email String
    The email address that the user has associated with their user profile.
    familyName String
    The last name of the user.
    givenName String
    The first name of the user.
    invited Boolean
    The field indicates whether the user has been invited to your account.
    loggedInAt String
    The last time that the user has logged into their Fivetran account.
    phone String
    The phone number of the user.
    picture String
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role String
    The role that you would like to assign to the user.
    verified Boolean
    The field indicates whether the user has verified their email address in the account creation process.
    createdAt string
    The timestamp that the user created their Fivetran account.
    email string
    The email address that the user has associated with their user profile.
    familyName string
    The last name of the user.
    givenName string
    The first name of the user.
    invited boolean
    The field indicates whether the user has been invited to your account.
    loggedInAt string
    The last time that the user has logged into their Fivetran account.
    phone string
    The phone number of the user.
    picture string
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role string
    The role that you would like to assign to the user.
    verified boolean
    The field indicates whether the user has verified their email address in the account creation process.
    created_at str
    The timestamp that the user created their Fivetran account.
    email str
    The email address that the user has associated with their user profile.
    family_name str
    The last name of the user.
    given_name str
    The first name of the user.
    invited bool
    The field indicates whether the user has been invited to your account.
    logged_in_at str
    The last time that the user has logged into their Fivetran account.
    phone str
    The phone number of the user.
    picture str
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role str
    The role that you would like to assign to the user.
    verified bool
    The field indicates whether the user has verified their email address in the account creation process.
    createdAt String
    The timestamp that the user created their Fivetran account.
    email String
    The email address that the user has associated with their user profile.
    familyName String
    The last name of the user.
    givenName String
    The first name of the user.
    invited Boolean
    The field indicates whether the user has been invited to your account.
    loggedInAt String
    The last time that the user has logged into their Fivetran account.
    phone String
    The phone number of the user.
    picture String
    The user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==')
    role String
    The role that you would like to assign to the user.
    verified Boolean
    The field indicates whether the user has verified their email address in the account creation process.

    Import

    1. To import an existing fivetran_user resource into your Terraform state, you need to get user_id.

    You can retrieve all users using the fivetran_users data source.

    1. Define an empty resource in your .tf configuration:

    hcl

    resource “fivetran_user” “my_imported_fivetran_user” {

    }

    1. Run the pulumi import command:
    $ pulumi import fivetran:index/user:User my_imported_fivetran_user {user_id}
    1. Use the terraform state show command to get the values from the state:

    terraform state show ‘fivetran_user.my_imported_fivetran_user’

    1. Copy the values and paste them to your .tf configuration.

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

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    fivetran 1.6.0 published on Tuesday, Mar 25, 2025 by fivetran
    fivetran/terraform-provider-fivetran