Role

Represents a predefined or custom set of permissions in your Fivetran account. Roles are assigned to users and teams to control what actions they can perform on specific resources. Each role has a scope that defines which resource types it applies to, such as the account, a destination, a connector, or a team.

Resource attributes

The following attributes describe a role and its scope.

Field name	Type	Description
`name`	string, read-only	Name of the role.
`description`	string, read-only	Description of the role's purpose.
`scope`	array of strings, read-only	Resource types the role applies to. Possible values: `ACCOUNT`, `DESTINATION`, `CONNECTOR`, `TEAM`.
`is_custom`	boolean, read-only	Indicates whether the role is a custom role created for the account (`true`) or a standard Fivetran-managed role (`false`).
`is_deprecated`	boolean, read-only	Indicates whether the role is deprecated and should no longer be used.
`replacement_role_name`	string, read-only	Name of the role that replaces this role when `is_deprecated` is `true`.

Supported operations

Category	Endpoint	Description
List	`GET /v1/roles`	Returns a paginated list of all roles available within your Fivetran account, including both standard and custom roles.