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
example:
limit
integer
Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.
format:
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Http + 1.1
GET
https://api.fivetran.com/v1/roles
GET /v1/roles?cursor=u8ygk2k56g26k5gy&limit=100 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
example:
message
string
Response status text
example:
data
objectrequired
items
arrayrequired
The collection of return items
name
stringrequired
The role name
example:
description
string
The role description
example:
scope
arrayrequired
Defines the list of resources the role manages
type:
is_custom
booleanrequired
Defines whether the role is standard or custom
nextCursor
string
The value of the cursor parameter for the next page
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"items": [
{
"name": "Destination Administrator",
"description": "Role Description",
"scope": "DESTINATION",
"is_custom": false
}
],
"nextCursor": "cursor_value"
}
}