roles

Creates, updates, deletes, gets or lists a roles resource.

Overview

Name	roles
Type	Resource
Id	fivetran.account.roles

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	The role name (example: Destination Administrator)
replacement_role_name	string	The name of the new role replacing the deprecated role (example: Manage Destination)
description	string	The role description (example: Role Description)
is_custom	boolean	Defines whether the role is standard or custom
is_deprecated	boolean	Defines whether the role is deprecated
scope	array	Defines the list of resources the role manages (ACCOUNT, DESTINATION, CONNECTOR, TEAM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select		cursor, limit	Returns a list of all predefined and custom roles within your Fivetran account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cursor	string	Paging cursor, [read more about pagination](https:​//fivetran.com/docs/rest-api/pagination)
limit	integer (int32)	Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

SELECT examples

list

Returns a list of all predefined and custom roles within your Fivetran account.

SELECT
name,
replacement_role_name,
description,
is_custom,
is_deprecated,
scope
FROM fivetran.account.roles
WHERE "limit" = '{{ limit }}'
;