Documentation

Documentation

  • Getting Started
  • Core Concepts
  • Using Fivetran
    • Fivetran IPs
    • Fivetran Dashboard
      • Connectors
      • Transformations
      • Destinations
      • Alerts
      • Organization Management
      • Account Settings
        • Users
        • Customer-Managed Keys
        • SCIM
        • Role-Based Access Control
        • Single Sign-On
        • Account Management Troubleshooting
      • User Management
    • Features
  • Usage-Based Pricing
  • Connectors
  • Applications
  • Databases
  • Files
  • Events
  • Functions
  • Destinations
  • Partner-Built
  • Transformations
  • Logs
  • Security
  • REST API
  • Local Data Processing (HVR 6)
  • Release Notes
RSS
Release notes RSS
HVR 5 Documentation
HVR 5 Documentation
  • Support
  • Sign In
Edit on GitHub

Account Managementlink

Updated November 16, 2023

Manage your account in the Account Settings section, a subsection of the Fivetran dashboard where you can manage administrative aspects of your account. Only specific roles in our role-based access control model can manage accounts.

NOTE: If you have a Free, Standard, Enterprise, or Business Critical account, you can also manage your Fivetran account using our REST API. See our REST API documentation for details.


Navigate account settingslink

IMPORTANT: The exact set of permissions depends on your user role and your Fivetran plan.

The Account Settings section is organized into pages, where you can manage the following aspects of your Fivetran account:

TabManagement Action
GeneralIncludes Account Settings and Powered by Fivetran tabs.
Account SettingsView and edit the account name and security configuration. View the HVR hub system registration logs.
Powered by FivetranCustomize your brand look across the Powered by Fivetran setup flow.
DownloadsDownload the latest builds of HVA and HVR.
Users & PermissionsIncludes the Users, Roles, and Teams tabs.
UsersCreate, view, edit, and delete users and their roles in the account, destinations, and for connectors.
RolesView standard roles. Create, view, edit, and delete custom roles.
TeamsCreate, view, edit, and delete teams and team member roles. Add and delete team members. Assign and unassign team members the Team Manager role.
Billing & UsageIncludes the Billing and Usage tabs.
BillingView and edit the account billing details, monitor consumption, or change your plan selection.
UsageView the account usage, MAR (monthly active rows), and MMR (monthly model runs) details.
Usage EstimatorView the estimates of your account spending.

To access your account settings, go to your Fivetran dashboard and find Account Settings in the left menu.

Account settings left nav

Switch accountlink

To change to a different user profile, click Switch account under your account name in the top left corner.

Switch account


Generallink

On the General page, you can change the account security configuration and the account name.

IMPORTANT: You need to have the Account Administrator role or a custom role with the Settings:Edit account permission to manage Account Settings.

Authentication Configlink

Restrict authentication type for account users in the Authentication Config section of the General page.

Authentication config

  1. Select the authentication type. Available options are:

    • No restrictions (users can choose to log in via Google OAuth or via SAML)

    • Google OAuth

    • SAML (for the list of supported providers, read our SSO documentation).

  2. Select the amount of time a dashboard session can remain inactive before timeout. Select a pre-set amount that ranges between 15 minutes to 2 weeks. The default browser session timeout is 1 day (24 hours). When the browser window is closed, your session times out automatically regardless of the settings.

    NOTE: The browser session timeout feature is only available for customers using the Enterprise or Business Critical pricing plan.

SAML Configlink

Configure SAML login in the SAML Config section of the General page.

To configure SSO with SAML, follow these steps:

  1. Switch the Enable SAML authentication toggle to on.

  2. If you want to use Just-In-Time (JIT) user provisioning, keep Enable user provisioning ON.

  3. Set the Sign on URL field value to the one provided by your SAML identity provider.

  4. Specify the Issuer, copying the issuer value from your SAML identity provider.

  5. Copy and paste your SAML identity provider's public certificate to the Public certificate field. Your public certificate should not include leading and trailing labels such as -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. Copy and paste only the value between these labels.

SAML Config new

See our Single Sign-On documentation for details on how single sign-on works in Fivetran.

SAML Just-In-Time (JIT) User Provisioninglink

Fivetran supports JIT User Provisioning. This feature helps automate the user account creation. If both Enable SAML authentication and Enable user provisioning settings are on, Fivetran will perform the following actions on each successful SAML sign-on:

  • If the user with the specified email address does not exist, Fivetran will create a new user with the email address, first name and last name as specified in the SAML assertion received from the Identity Provider.
  • If the user exists, but their first name or last name have changed, Fivetran will update these fields with the new values.

If Enable user provisioning is OFF and the user with the specified email address does not exist, a sign-on attempt via SAML will throw an error.

IMPORTANT: Fivetran's Role-Based Access Model determines the permissions of a user. The new user is created with no permissions if System for Cross-domain Identity Management (SCIM) is not enabled in Fivetran for user provisioning. If SCIM is not set up, then a Fivetran user with the Users: Manage permission needs to grant this user the relevant role with the corresponding permissions on the Users tab. If SCIM is set up on the Fivetran account, then you can use the associated services provisioning feature to automatically grant permissions to your users.

Change the account namelink

To change the account name, follow these steps:

  1. At the top of the page, enter a new name in the Name field.
  2. Click Save.

Rename account

HVR Settingslink

Fivetran customers on the Business Critical Plan have access to HVR’s real-time data replication technology. To download the HVR application, click the Download HVR 6.1 link.

HVR Settings

HVR customers who have registered their hub system with a Fivetran account can view the following registration details:

  • Fivetran account user name
  • Registration ID - A system-generated unique identifier for the registration between a hub system and your Fivetran account.
  • Server URL
  • Hub Fingerprint
  • Port number
  • Created date
  • Last Updated date
  • Confirmation status - true indicates that the hub system registration was successful, false indicates registration failure.

NOTE: To delete an outdated hub system registration, click X.


Users & Permissionslink

The Users & Permissions page contains three tabs - Users, Roles, and Teams.

Userslink

On the Users tab, you can:

  • View the list of users who are members of your account and their permissions
  • Add users to your account
  • Remove users from your account
  • Set account roles to users in the account
  • Set destination roles to users for specific destinations within your account
  • Set connector roles per connector in each destination

View user listlink

The user list displays the Name, Email, and Account Role of each user.

View user list

View user detailslink

The User Details page displays the Name and Account Role of the user. To view the User Details page, click on the user in the user list.

The Destinations tab of the User Details page displays the Name and Type of every destination, as well as the user's Role in the destination. The view link displays the list of connectors in the destinations and the user's roles for these connectors.

View User Details page

The Connectors tab of the User Details page displays the Name, Type, and Destination of every connector, as well as the user's Role for every connector.

You can search the destination and connector lists by name and filter by type.

Add or remove userslink

To add a user, click + Add User. To remove an existing user, click the trash can icon to the right of the user's name.

Add or remove users

NOTE: If you don't have Account Administrator role, you can still add users to a specific destination.

Assign roles to a userlink

You assign a user an account role when you add a user. Later, you can assign a different account role to the user. Depending on the set account role and intended permissions, you may also need to assign the user separate destination roles and connector roles. You can assign one role for each destination in your account and one role for each connector in the destination.

To assign user roles to a user, do the following:

  1. In the user list on the Users tab, click the user's name.

  2. On the User Details page, select the new account role from the Account Role drop-down menu.

    TIP: Hover over the gray i to see information about each role.

    View user list

  3. Click the Destinations tab and use the Role drop-down to select the role for each destination.

  4. Click the Connectors tab and use the Role drop-down to select the role per connector.

  5. Click Back to users to return to the user list.

Roleslink

IMPORTANT: You must have an Enterprise or Business Critical plan to create and manage custom user roles.

TIP: If you want a user to have access to all destinations, set the Account role based on the permissions you want that user to have. If you want a user to have access to a specific destination and its connectors, we recommend setting a destination-level role for that destination.

On the Roles tab, you can view the list of roles defined for your account, the access areas, and the number of users who are assigned each role.

Roles tab

You can also create, update, and delete custom roles.

Create a custom rolelink

To add a new custom role, do the following:

  1. Click +Add Role at the top right of the page.

  2. Specify Role Name.

  3. Enter a Description.

    TIP: Since the description text is displayed as a hint when you hover over the role, we suggest that you enter a detailed description for the new custom role that includes all of its accessible resources and set permissions.

  4. Enable or disable access to various resources using the toggles, then define their specific resource area permissions by selecting the relevant permissions from the drop-down menus:

    • Account level-permissions

    • Destination level-permissions

    • Connector access area with its specific access options:

      • All - select this option to enable access to all connector types
      • Selected - select this option to enable access to only certain connector types. Use the search to find connector types and check the box to enable access
      • None - select this option to disable access to connectors

      NOTE: The Connector permissions are applied to all connector types that are accessible to the custom role.

  5. Click Save to save.

Update a custom rolelink

To edit a custom role, do the following:

  1. In the user role list on the Roles tab of your Fivetran dashboard, click the pencil icon on the right of the relevant role row.
  2. Define the new values and settings of the custom role properties.
  3. Click Save to save the changes.

Delete a custom rolelink

To delete a custom role, do the following:

  1. In the user role list on the Roles tab , click the trash can icon on the right in the relevant role row.

    Delete custom role

  2. If the role you are deleting has any assigned users, a warning displays in the top right corner of your dashboard, prompting you to assign those users new roles.

  3. On the Users tab of your Fivetran dashboard, assign a new role to the users with the custom role you want to delete.

  4. On the Roles tab, make sure the role you are deleting has 0 users, and click the trash can icon.

  5. In the confirmation popup window, click Delete to permanently make this change.

Teamslink

On the Teams tab, you can manage teams, team members, teams' roles in the account, destinations, and for connectors.

On the Teams tab, you can:

  • View the list of teams and their managers
  • View team information:
    • list of team members
    • role of the team in each destination and by connectors within a destination
    • role of the team for each connector in each destination
  • Assign and unassign teams a role in the account and a role per destination and connector
  • Add, edit and delete teams
  • Invite users to a team and remove them from the team
  • Grant users the Team Manager role and revoke it

View team listlink

The team list displays the Name, Managers, and number of Members of each team. The Managers column displays the names of all assigned team managers. To see the full list of the team's managers, hover over the number beside the team creator's name.

View team list

Add a teamlink

To add a team:

  1. Click + Add Team. Add team
  2. Enter the Team name.
  3. Enter the Description.
  4. Invite Team Members by checking the boxes beside the relevant users's name. Team new

    NOTE: You can only invite users within your Fivetran account.

  5. Click OK.

Delete a teamlink

To delete an existing team:

  1. Click the trash can icon to the right of its name.
  2. Type "DELETE" in the confirmation popup window.
  3. Click Delete.

Delete a team

View team member listlink

To view the team member list, click a team in the team list. The team list on the Members tab of the Team Details page appears. You can view the team member names, whether the user has the Team Manager role, and their last activity.

View the team member list

Add users to a teamlink

To add users to a team:

  1. On the Members tab, click Add Members.

  2. In the Add Team Member popup, search for the users you want to invite to the team and check the box beside their name to select them. Repeat this step for each user you want to add.

    Add a user

    NOTE: You can only invite users within your Fivetran account.

  3. Click Add.

Assign and unassign users the Team Manager rolelink

Team Managers have the following permissions in their teams:

  • edit and delete their teams
  • add and delete team members
  • assign team members the Team Manager role

A user who is a part of the team and not a team manager is classified as a team member. Team members have no permissions to modify or delete the team.

To assign team members the Team Manager role, on the Members tab, check the Team Managers checkbox.

To unassign the Team Manager role, uncheck the relevant checkboxes.

NOTE: Only Team Managers and Account Administrators can assign and unassign the Team Manager role.

Remove user from a teamlink

To remove user from a team:

  1. On the Members tab, select the user you want to remove, and click the trash can icon.
  2. In the confirmation popup window, click Remove.

Remove a user

Assign and unassign the team roleslink

To assign and unassign the team roles:

  1. On the Roles tab of the Team Details page, select the relevant Account Role.
  2. Click the Destinations tab and use the Role drop-down to select the role for each destination.
  3. Click the Connectors tab and use the Role drop-down to select the role per connector.
  4. To unassign a role, select - as a value in the relevant role field.

Assign a team roles

When a user creates a connector or destination, they automatically become the Connector Administrator or Destination Administrator, respectively. Users can only set the role for connectors or modify connectors for which they are Connector Administrators. Similarly, users can only set the role for destinations or modify destinations for which they are Destination Administrators.

View team roles by destination and connectorslink

The destination list on the Roles tab of the Team Details page displays the team's role for each destination in the group. To view the team's role by connectors in the destination, click View Connectors.

View Connectors

Edit a teamlink

To change a team's details:

  1. On the Settings tab, enter a new Team Name.

  2. Enter a new Description.

    Edit a team

  3. Click Save.


Billing & Usagelink

Billinglink

The Billing tab displays your current and past monthly spend details. You can also view and change your plan and payment details.

Billing tab

Fivetran users with the following roles can access the Billing tab:

  • Account Administrator
  • Account Billing

Monitor your consumptionlink

The consumption section in the top left corner of the Billing tab looks different based on whether you have an annual subscription, purchased Fivetran online, or purchased Fivetran through a partner marketplace.

NOTE: If you are using a credits-based plan, see the Monitor your credit consumption section.

Annual subscriptionlink

The Subscription period graph shows how much time is left in your subscription. The Spend tracker graph shows your consumption.

View your overall consumption rate

NOTE: If you're consuming your spend balance at a higher rate than anticipated, you'll see a You may need to add to your spend balance message.

To connect to our Sales team, click Talk to Sales.

Online purchasinglink

In the consumption section, you can see details about your monthly spend.

NOTE: Online plans automatically renew monthly, and you are auto-charged through your credit card each month.

To see more detailed usage information, click See usage.

Partner marketplacelink

In the consumption section, you can see details about your monthly spend.

To see more detailed usage information, click See usage.

Configure usage alertslink

IMPORTANT: You need an Account Administrator or Account Billing role to receive usage alerts.

Use the Alert me about my monthly spend toggle to configure usage alerts. ​​Set the toggle to ON, and enter a monthly spend threshold. When your spend within a month reaches this threshold, we send you an email notification.

Set usage alerts

NOTE: If you are using a credits-based plan, see the Set up credit usage alerts section.

View past usagelink

The Monthly spend bar chart shows your monthly spend. By default, the chart displays data from the current year and for all destinations. To see data from past years or for a specific destination, use the drop-down menus in the top-right corner.

View your past usage

NOTE: If you are using a credits-based plan, see the View past credit consumption section.

View or change billing planlink

Below the consumption and alert sections, you can see your current billing plan.

View billing plan details

To change your plan, click Manage plan. You will be redirected to the plan comparison page. Follow the instructions on the page.

NOTE: If you are using a credits-based plan, see the View billing plan section.

If you purchased Fivetran through a partner marketplace, at the top of the Billing tab, you'll see a link to your partner marketplace. Click this link if you want to change your plan.

Change your plan through your partner marketplace

View or change payment methodlink

Next to the plan section, you'll see your current method of payment. The Payment section looks different based on whether you have an annual subscription, purchased Fivetran online, or purchased Fivetran through a partner marketplace.

Annual subscriptionlink

The Payment section shows details of your annual subscription. To add a credit card for any overage charges, click Add a credit card for any overages.

View contract details and add a credit card for overages

Online purchasinglink

The Payment section shows details of your online purchasing plan, including the credit card you're currently using. If you want to pay with a different credit card, click Change credit card.

NOTE: Online plans automatically renew monthly, and you are auto-charged through your credit card each month.

View online payment details and change credit card

Partner marketplacelink

The Payment section shows details of your marketplace payment plan. To visit the partner marketplace where you bought Fivetran, click Visit Marketplace.

View billing details through partner marketplace

View transaction historylink

The Transaction History tab lists all of your past transactions from newest to oldest.

View transaction history

View invoiceslink

The Invoices tab lists all of your past invoices from newest to oldest. For each invoice, we display the invoice date, cost, remaining balance, and invoice number. To download an invoice, click the download icon next to the invoice number.

View invoices

NOTE: If you are using a credits-based plan, see the View past invoices section.

Cancel planlink

If you purchased Fivetran online, you can cancel your plan from the Billing tab. To cancel your plan, click Manage plan on plan card and then the Cancel Plan button at the bottom of the page.

Manage plan

NOTE: Cancellation can take up to 10 minutes to be effective and show on your dashboard.

Promotionslink

Promotions allow you to try a specific set of features for a limited time for no additional cost. If you have Account Administrator or Account Billing permissions, you can enroll in a promotion directly in your Fivetran dashboard.

Promotions are available for pricing plans. With a promotion, you can access a specific plan for no additional cost for twenty-eight days.

IMPORTANT: Promotions are only available for users with Free and Standard plans. If you have a Free plan, you can access the features that are available in a Standard plan. If you have a Standard plan, you can access the features that are available in an Enterprise plan.

Enroll in a promotionlink

When on a qualified pricing plan, you can access promotions through the following features in the dashboard:

  • Database connectors
  • REST API access
  • SSH tunnels
  • Improved sync times
  • External log monitoring
  • Custom user roles
  • Cloud service providers
  • SLA for data delivery

These features have a prompt next to them that reads Unlock this feature. Learn more or Unlock source. Learn more.

  1. Find a feature on your dashboard with a Learn more prompt.

    Feature with a promotion prompt

  2. Click on the Learn more prompt. A pop-up window appears that describes the promotion.

    Promotions pop-up on dashboard

  3. In the pop-up window, click Try now to enroll in the promotion or Remind me to set a reminder.

    When you select Remind me, an email request is sent to the Account Administrator. The email request describes the available promotion and links the Account Administrator to the Billing tab to sign up.

    NOTE: If you do not have Account Administrator or Account Billing permissions, you can send a promotion enablement request to a user with Account Administrator or Account Billing permissions.

Monitor a promotionlink

When you enroll in a promotion, you can see an overview of all the new features and benefits in your dashboard.

Pricing plan promotions overview

Your Billing tab tracks the number of days remaining in your promotion.

Billing for credits-based planslink

Monitor your credit consumptionlink

The credit consumption section looks different based on whether you have an annual subscription, purchased Fivetran online, or purchased Fivetran through a partner marketplace.

Annual subscriptionlink

The credit consumption bar graph shows at a glance how many of your credits you have used and how much time is left in your contract. If you're consuming credits at a higher rate than anticipated, you'll see a You may need more credits message.

View your overall credit consumption rate

If you need to buy more credits, click Talk to Sales at the bottom of the chart to connect to our Sales team

Online purchasinglink

In the credit consumption section, you can see how many credits you have used so far this month.

View your monthly credit usage total

To see more detailed usage information, click See usage.

Partner marketplacelink

In the credit consumption section, you can see how many credits you have used so far this month.

View your monthly credit usage total

To see more detailed usage information, click See usage.

At the top of the Billing tab, you'll see a link to your partner marketplace. Click this link if you want to change your plan.

Change your plan through your partner marketplace

Set up credit usage alertslink

IMPORTANT: You need an Account Administrator or Account Billing role to receive credit usage alerts.

Use the Alert me on my credit usage toggle to configure credit usage alerts.

Set credit alerts

View past credit consumptionlink

The Credit Consumption bar chart displays credit consumption by month. Hover over each bar to see how many credits you consumed. By default, the chart displays data from the current year and for all destinations. To see data from past years and/or for a specific destination, use the drop-down menus in the top-right corner.

View past credit consumption

View billing planlink

Below the consumption and alert sections, you can see your current billing plan.

View billing plan details

To view all plans side-by-side, click Manage plan. You'll be redirected to comparison page. If you'd like to change your plan, follow the instructions on the plan comparison page.

View past invoiceslink

The Invoices section lists all of your past invoices from newest to oldest. For each invoice, we display the invoice date, cost, remaining balance, and invoice number. To download an invoice, click the download icon next to the invoice number.

View past invoices

Usagelink

The Usage tab displays the usage information for your account by month.

Fivetran users with the following roles can access the Usage tab:

  • Account Administrator
  • Account Billing

View monthly spendlink

The total spend so far this month section displays the cost you have incurred.

NOTE: If you are using a credits-based plan, see the View monthly credits usage section.

The Connectors section shows how many active rows you consumed in the selected month and the cost you have incurred. This section includes two types of MAR, paid MAR and free MAR (for which you are not billed). If you're viewing data for the current month, you'll see your MAR to date (month-to-date active rows).

Free MAR comes from account-level free trials, new connector free use periods, initial syncs, free re-syncs, re-syncs initiated by Fivetran, and from operations performed by the Fivetran Platform Connector and other system tables.

NOTE: If you are using a credits-based plan, see the View paid and free MAR section.

The Transformations section shows how many model runs you have made in the selected month.

View daily MAR by destination, connector, and tablelink

The Daily MAR bar chart in the Connectors tab displays your paid and free MAR for each day of the selected month so that you can see trends in your consumption. Your free MAR may change over the course of the month as we process the primary keys that we use to calculate paid MAR.

View daily MAR by destination and connector

Hover over each bar to see your overall daily MAR and the daily MAR for your top three connectors.

Hover to view daily overall MAR and MAR from top three connectors

By default, the chart displays data for all destinations, connectors, and tables.

  • To see data for a specific destination, use the destination drop-down menu above the Daily MAR chart.

    Filter daily MAR data by destination

  • To see data for a specific connector or connectors, scroll down to the connectors list. Select the ones you want to see the data for.

    Filter daily MAR data by connector

    In the connector list, you can view the following connector-specific information:

    • The connector name
    • The associated destination
    • MAR consumed
    • The percent of your account's MAR that the connector represents
    • Percent change in MAR from the previous month
  • To see data for a specific table or tables, select the connector in the list underneath the chart and then click > (right arrow). Select the table(s) from the list.

    Filter daily MAR data by table

    In the table list, you can view the following table-specific information:

    • The table name
    • MAR consumed
    • Percent change in MAR from the previous month

NOTE: We calculate the percent change by comparing this month's MAR to date to the MAR from the equivalent period last month (for example, we compare May 1-10 to April 1-10).

View daily MAR by productlink

IMPORTANT: Only applicable for Fivetran Business Critical and HVR customers.

By default, the Daily MAR chart in the Connectors tab displays the total combined paid and free MAR for Fivetran and HVR.

  • To view the daily MAR data of your Fivetran account, select Fivetran connectors from the connectors drop-down.

  • To view the daily MAR data of your HVR hub system, select HVR connectors from the connectors drop-down.

    Filter HVR MAR

View daily model runs by destination and transformationlink

The Daily model runs chart in the Transformations tab displays the number of model runs for each day of the selected month.

View daily MMR by destination

Hover over each bar to see your overall model runs and the daily model runs for your top three jobs.

By default, the chart displays data for all destinations.

  • To see data for a specific destination, use the drop-down menu in the top-right corner of the chart.

    View daily MMR for specific destination

  • To see data for a specific transformation or transformations, scroll down to the transformations list. Select the ones you want to see the data for.

    View daily MMR for specific transformation

In the transformation list, you can view the following transformation-specific information:

  • The transformation name

  • The associated destination

  • Monthly model runs (MMR)

  • The percent of your account's MMR that the transformation represents

  • Percent change in MMR from the previous month

    NOTE: We calculate the percent change by comparing this month's MMR to date to the MMR from the equivalent period last month (for example, we compare May 1-10 to April 1-10).

View past usage datalink

By default, the Usage tab shows data from the current month. To see past usage data, use the drop-down menu at the top of the Usage tab to select the month you'd like to view.

View monthly credits usagelink

If you are using a credits-based plan, in the Usage tab you can see how many credits you used in the selected month. If you're viewing data for the current month, you'll see how many credits you've used to date (month-to-date credit usage). To learn more about how Fivetran calculates credits, click See credit calculation.

Filter daily MAR data by table

View paid and free MARlink

If you are using a credits-based plan, in the MAR section you can see how many active rows you consumed in the selected month. If you're viewing data for the current month, you'll see your MAR to date (month-to-date active rows).

Paid MAR


Downloadslink

NOTE: This section applies only to High-Volume Agent (HVA) and HVR downloads.

On the Account Settings > Downloads page, you can download the latest builds of HVA and HVR for various operating systems, as well as corresponding release notes.

Downloads

By default, all HVR customers can view the downloads. However, if you do not see the Downloads tab, it means access must be enabled for you. Reach out to our support team to request access.

If you do not find the required HVA or HVR version on the Downloads tab, reach out to our support team to request it.


Questions?

We're always happy to help with any other questions you might have! Send us an email.

    Thanks for your feedback!
    Was this page helpful?