1. Packages
  2. Fivetran Provider
  3. API Docs
  4. getRoles
Viewing docs for fivetran 1.9.26
published on Friday, Mar 20, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-fivetran

fivetran.getRoles

fivetran logo
Viewing docs for fivetran 1.9.26
published on Friday, Mar 20, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-fivetran

    This data source returns a list of all predefined and custom roles within your Fivetran account.

    Example Usage

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

const roles = fivetran.getRoles({});

    import pulumi
import pulumi_fivetran as fivetran

roles = fivetran.get_roles()

    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.GetRoles(ctx, &fivetran.GetRolesArgs{}, nil)
		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 roles = Fivetran.GetRoles.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetRolesArgs;
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 roles = FivetranFunctions.getRoles(GetRolesArgs.builder()
            .build());

    }
}

    variables:
  roles:
    fn::invoke:
      function: fivetran:getRoles
      arguments: {}

    Using getRoles

    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 getRoles(args: GetRolesArgs, opts?: InvokeOptions): Promise<GetRolesResult>
function getRolesOutput(args: GetRolesOutputArgs, opts?: InvokeOptions): Output<GetRolesResult>
    def get_roles(roles: Optional[Sequence[GetRolesRole]] = None,
              opts: Optional[InvokeOptions] = None) -> GetRolesResult
def get_roles_output(roles: Optional[pulumi.Input[Sequence[pulumi.Input[GetRolesRoleArgs]]]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRolesResult]
    func GetRoles(ctx *Context, args *GetRolesArgs, opts ...InvokeOption) (*GetRolesResult, error)
func GetRolesOutput(ctx *Context, args *GetRolesOutputArgs, opts ...InvokeOption) GetRolesResultOutput

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

    public static class GetRoles 
{
    public static Task<GetRolesResult> InvokeAsync(GetRolesArgs args, InvokeOptions? opts = null)
    public static Output<GetRolesResult> Invoke(GetRolesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)
public static Output<GetRolesResult> getRoles(GetRolesArgs args, InvokeOptions options)

    fn::invoke:
  function: fivetran:index/getRoles:getRoles
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getRoles Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Roles List<GetRolesRole>
    Id string
    The ID of this resource.
    Roles []GetRolesRole
    id String
    The ID of this resource.
    roles List<GetRolesRole>
    id string
    The ID of this resource.
    roles GetRolesRole[]
    id str
    The ID of this resource.
    roles Sequence[GetRolesRole]
    id String
    The ID of this resource.
    roles List<Property Map>

    Supporting Types

    GetRolesRole

    Description string
    The role description
    IsCustom bool
    Defines whether the role is standard or custom
    IsDeprecated bool
    Defines whether the role is deprecated
    Name string
    The role name
    ReplacementRoleName string
    The name of the new role replacing the deprecated role
    Scopes List<string>
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
    Description string
    The role description
    IsCustom bool
    Defines whether the role is standard or custom
    IsDeprecated bool
    Defines whether the role is deprecated
    Name string
    The role name
    ReplacementRoleName string
    The name of the new role replacing the deprecated role
    Scopes []string
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
    description String
    The role description
    isCustom Boolean
    Defines whether the role is standard or custom
    isDeprecated Boolean
    Defines whether the role is deprecated
    name String
    The role name
    replacementRoleName String
    The name of the new role replacing the deprecated role
    scopes List<String>
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
    description string
    The role description
    isCustom boolean
    Defines whether the role is standard or custom
    isDeprecated boolean
    Defines whether the role is deprecated
    name string
    The role name
    replacementRoleName string
    The name of the new role replacing the deprecated role
    scopes string[]
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
    description str
    The role description
    is_custom bool
    Defines whether the role is standard or custom
    is_deprecated bool
    Defines whether the role is deprecated
    name str
    The role name
    replacement_role_name str
    The name of the new role replacing the deprecated role
    scopes Sequence[str]
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM
    description String
    The role description
    isCustom Boolean
    Defines whether the role is standard or custom
    isDeprecated Boolean
    Defines whether the role is deprecated
    name String
    The role name
    replacementRoleName String
    The name of the new role replacing the deprecated role
    scopes List<String>
    Defines the list of resources the role manages. Supported values: ACCOUNT, DESTINATION, CONNECTOR, and TEAM

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    Viewing docs for fivetran 1.9.26
    published on Friday, Mar 20, 2026 by fivetran
    Schema (JSON)
    fivetran/terraform-provider-fivetran
      Try Pulumi Cloud free. Your team will thank you.