Role Management

Our REST API supports the following role management actions:

List all roles

List all roles

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

Request

GET https://api.fivetran.com/v1/roles

Query parameters

Name	Description
`cursor`	paging cursor, read more about pagination
`limit`	number of records to fetch per page, accepts a number in the range 1..1000, the default value is 100

Response

HTTP 200 OK

{
  "code": "Success",
  "data": {
    "items": [
      {
        "name": "Account Administrator",
        "description": "Can view and change account information, including billing, users, roles, API access, and security settings. Can create, manage, and delete destinations and connectors. Can manage transformations and logs.",
        "is_custom": false,
        "scope": ["ACCOUNT"]
      },
      {
        "name": "Destination Reviewer",
        "description": "Can view the destinations that you are invited to and their associated connectors. Cannot create, delete, or manage destinations or connectors. Cannot access account information.",
        "is_custom": false,
        "scope": ["DESTINATION"]
      }
    ],
    "next_cursor": "eyJza2lwIjoxfQ"
  }
}

Fields

Name	Description
`items`	The collection of roles
`item.name`	The role name
`item.description`	The role description
`item.is_custom`	Defines whether the role is standard or custom
`item.scope`	Defines the list of resources the role manages. Supported values: `ACCOUNT`, `DESTINATION`, `CONNECTOR`, and `TEAM`
`next_cursor`	The value of the `cursor` parameter for the next page