List all roles
Returns a list of all predefined and custom roles within your Fivetran account.
Request schema
Query parameters
cursor
string
Paging cursor, read more about pagination
limit
integer
Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.
format:
int32
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
example:
application/json
default:
application/json
Http + 1.1
GET
https://api.fivetran.com/v1/roles
GET /v1/roles?cursor=null&limit=null HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Host: api.fivetran.com
Responses
200
Successful response
Successful response schema
code
stringrequired
Response status code
message
string
Response status text
data
objectrequired
items
arrayrequired
The collection of return items
name
stringrequired
The role name
description
string
The role description
scope
array
Defines the list of resources the role manages
type:
string
is_custom
booleanrequired
Defines whether the role is standard or custom
nextCursor
string
The value of the cursor parameter for the next page
null