User Management
REST API supports the following user management actions:
List All Users
Returns a list of all users within your Fivetran account.
Request
GET api.fivetran.com/v1/users
Query parameters
| Name | Description |
|---|---|
cursor |
paging cursor, read more about pagination |
limit |
amount of records to fetch, accepts a number in the range 1..1000, the default value is 100 |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "nozzle_eat",
"email": "john@mycompany.com",
"given_name": "John",
"family_name": "White",
"verified": true,
"invited": false,
"picture": null,
"phone": null,
"logged_in_at": "2019-01-03T08:44:45.369Z",
"created_at": "2018-01-15T11:00:27.329220Z"
},
{
"id": "prophecies_falsely",
"email": "robert@mycompany.com",
"given_name": "Robert",
"family_name": "Brown",
"verified": true,
"invited": false,
"picture": null,
"phone": null,
"logged_in_at": "2018-12-12T12:06:15.337Z",
"created_at": "2018-01-24T20:43:32.963843Z"
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
Fields
| Name | Description |
|---|---|
items |
The collection of users |
next_cursor |
The value of the cursor parameter for the next page |
Retrieve User Details
Returns a user object if a valid identifier was provided.
Request
GET api.fivetran.com/v1/users/{user_id}
Path parameters
| Name | Description |
|---|---|
user_id (required) |
The unique identifier for the user within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "nozzle_eat",
"email": "john@mycompany.com",
"given_name": "John",
"family_name": "White",
"verified": true,
"invited": false,
"picture": null,
"phone": null,
"logged_in_at": "2019-01-03T08:44:45.369Z",
"created_at": "2018-01-15T11:00:27.329220Z"
}
}
Fields
| Name | Description |
|---|---|
id |
The unique identifier for the user within the Fivetran system. |
email |
The email address that the user has associated with their user profile. |
given_name |
The first name of the user. |
family_name |
The last name of the user. |
verified |
The field indicates whether the user has verified their email address in the account creation process. |
invited |
The field indicates whether the user has been invited to your account. |
phone |
The phone number of the user. |
picture |
The url of the user's avatar. |
logged_in_at |
The last time that the user has logged into their Fivetran account. |
created_at |
The timestamp that the user created their Fivetran account. |
Invite a User
Invites a new user to your Fivetran account. The invited user will have access to the account only after accepting the invitation. Invited user details are still accessible through the API.
Request
POST api.fivetran.com/v1/users
{
"given_name": "John",
"family_name": "White",
"email": "john.white@mycompany.com",
"phone": "+1234567890",
"picture": "http://mycompany.com/avatars/john_white.png",
"role": "ReadOnly"
}
Payload parameters
| Name | Description |
|---|---|
email (required) |
The email address that the user has associated with their user profile. |
given_name (required) |
The first name of the user. |
family_name (required) |
The last name of the user. |
phone |
The phone number of the user. |
picture |
The url of the user's avatar. |
role (required) |
The account role that you would like to assign this new user to. Supported account roles: 'ReadOnly', 'Owner'. |
Response
HTTP 201 Created
{
"code": "Success",
"message": "User has been invited to the account",
"data": {
"id": "firewood_martial",
"email": "john.white@mycompany.com",
"given_name": "John",
"family_name": "White",
"verified": false,
"invited": true,
"picture": "http://mycompany.com/avatars/john_white.png",
"phone": "+123456789",
"logged_in_at": null,
"created_at": "2019-01-20T16:03:36.786936Z"
}
}
Modify a User
Updates information for an existing user within your Fivetran account.
Request
PATCH api.fivetran.com/v1/users/{user_id}
{
"given_name": "John",
"family_name": "White",
"phone": "+1234567890",
"picture": "http://mycompany.com/avatars/john_white.png",
"role": "ReadOnly"
}
Path parameters
| Name | Description |
|---|---|
user_id (required) |
The unique identifier for the user within the Fivetran system. |
Payload parameters
| Name | Description |
|---|---|
given_name |
The first name of the user. |
family_name |
The last name of the user. |
phone |
The phone number of the user. |
picture |
The url of the user's avatar. |
role |
The account role that you would like to assign this new user to. Supported account roles: 'ReadOnly', 'Owner'. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "User has been updated",
"data": {
"id": "firewood_martial",
"email": "john.white@mycompany.com",
"given_name": "John",
"family_name": "White",
"verified": false,
"invited": true,
"picture": "http://mycompany.com/avatars/john_white.png",
"phone": "+123456789",
"logged_in_at": null,
"created_at": "2019-01-20T16:03:36.786936Z"
}
}
Delete a user
Deletes a user from your Fivetran account. You will be unable to delete an account owner user if there is only one remaining.
Request
DELETE api.fivetran.com/v1/users/{user_id}
Path parameters
| Name | Description |
|---|---|
user_id (required) |
The unique identifier for the user within the Fivetran system. |
Response
HTTP 200 OK
{
"code": "Success",
"message": "User with id 'firewood_martial' has been deleted"
}