User Managementlink
Our REST API supports the following user management actions:
- List all users
- Retrieve user details
- Invite a user
- Modify a user
- Delete user role in account
- Delete a user
Connector membershipslink
- List all connector memberships
- Retrieve connector membership
- Add connector membership
- Update connector membership
- Delete connector membership
Group membershipslink
- List all group memberships
- Retrieve group membership
- Add group membership
- Update group membership
- Delete group membership
List All Userslink
Returns a list of all users within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/users
Query parameterslink
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 |
Responselink
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,
"role": "Account Administrator",
"logged_in_at": "2019-01-03T08:44:45.369Z",
"created_at": "2018-01-15T11:00:27.329220Z",
"active": true
},
{
"id": "prophecies_falsely",
"email": "robert@mycompany.com",
"given_name": "Robert",
"family_name": "Brown",
"verified": true,
"invited": false,
"picture": null,
"phone": null,
"role": null,
"logged_in_at": "2018-12-12T12:06:15.337Z",
"created_at": "2018-01-24T20:43:32.963843Z",
"active": true
}
],
"next_cursor": "eyJza2lwIjoyfQ"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
items | The collection of users |
next_cursor | The value of the cursor parameter for the next page |
Retrieve User Detailslink
Returns a user object if a valid identifier was provided.
Requestlink
GET https://api.fivetran.com/v1/users/{user_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Responselink
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,
"role": "Account Reviewer",
"logged_in_at": "2019-01-03T08:44:45.369Z",
"created_at": "2018-01-15T11:00:27.329220Z",
"active": true
}
}
content_copy
Fieldslink
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 user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==') |
role | The account role of the user. Possible values: ‘Account Billing’, ‘Account Administrator’, ‘Account Reviewer’, ‘Account Analyst’, custom role name, or ‘null’. |
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. |
active | The boolean value indicating the user's status. If the user is able to log in, the value is true . If the user's account has been suspended, the value is false . |
Invite a Userlink
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.
Requestlink
POST https://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": "Account Reviewer"
}
content_copy
Payload parameterslink
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 user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==') |
role | The account role that you would like to assign this new user to. Possible values: Account Administrator , Account Billing , Account Analyst , Account Reviewer , Destination Creator , null , or a custom role with account-level permissions. |
Responselink
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",
"role": "Account Administrator",
"logged_in_at": null,
"created_at": "2019-01-20T16:03:36.786936Z",
"active": true
}
}
content_copy
Modify a Userlink
Updates information for an existing user within your Fivetran account.
Requestlink
PATCH https://api.fivetran.com/v1/users/{user_id}
{
"given_name": "John",
"family_name": "White",
"phone": "+1234567890",
"picture": "http://mycompany.com/avatars/john_white.png",
"role": "Account Billing"
}
content_copy
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Payload parameterslink
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 user's avatar as a URL link (for example, 'http://mycompany.com/avatars/john_white.png') or base64 data URI (for example, 'data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==') |
role | The account role that you would like to assign this new user to. Possible values: Account Administrator , Account Billing , Account Analyst , Account Reviewer , Destination Creator , or a custom role with account-level permissions. |
Responselink
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",
"role": "Account Administrator",
"logged_in_at": null,
"created_at": "2019-01-20T16:03:36.786936Z",
"active": true
}
}
content_copy
Delete user role in accountlink
Removes a user's role in account.
NOTE: If the user has a role in a group, or a role that links the user to a connector, these roles remain unchanged for the user.
Requestlink
DELETE https://api.fivetran.com/v1/users/{user_id}/role
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "User role in account has been removed"
}
content_copy
Delete a userlink
Deletes a user from your Fivetran account. You can't delete an Account Administrator user if there is only one in your account.
Requestlink
DELETE https://api.fivetran.com/v1/users/{user_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "User with id 'firewood_martial' has been deleted"
}
content_copy
List all connector membershipslink
Returns all connector membership objects for a user within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/users/{user_id}/connectors
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Query parameterslink
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 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "connector_id_1",
"role": "Connector Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
},
{
"id": "connector_id_2",
"role": "Connector Reviewer",
"created_at": "2020-05-25T15:26:47.306509Z"
}
],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
items | The collection of connector memberships |
item.id | The connector unique identifier |
item.role | The role that links the user to the connector |
item.created_at | The date and time the membership was created |
next_cursor | The value of the cursor parameter for the next page |
Retrieve connector membershiplink
Returns a connector membership object.
Requestlink
GET https://api.fivetran.com/v1/users/{user_id}/connectors/{connector_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "connector_id",
"role": "Connector Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
data.id | The connector unique identifier |
data.role | The role that links the user to the connector |
data.created_at | The date and time the membership was created |
Add connector membershiplink
Adds a connector membership.
Requestlink
POST https://api.fivetran.com/v1/users/{user_id}/connectors
{
"id": "connector_id",
"role": "Connector Administrator"
}
content_copy
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Payload parameterslink
Name | Description |
---|---|
connector_id (required) | The unique identifier for the connector within the account. |
role (required) | The role that you would like to assign to the user to link the user to the connector. Possible values: Connector Administrator , Connector Collaborator , Connector Reviewer , or a custom role with connector level permissions. |
Responselink
HTTP 201 CREATED
{
"code": "Created",
"message": "Connector membership has been created",
"data": {
"id": "connector_id",
"role": "Connector Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
data.id | The connector unique identifier |
data.role | The role that links the user to the connector |
data.created_at | The date and time the membership was created |
Update connector membershiplink
Updates connector membership.
Requestlink
PATCH https://api.fivetran.com/v1/users/{user_id}/connectors/{connector_id}
{
"role": "Connector Administrator"
}
content_copy
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Payload parameterslink
Name | Description |
---|---|
role (required) | The role that you would like to assign to the user to link the user to the connector. Possible values: Connector Administrator , Connector Collaborator , Connector Reviewer or a custom role with connector level permissions. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Connector membership has been updated"
}
content_copy
Delete connector membershiplink
Removes connector membership.
Requestlink
DELETE https://api.fivetran.com/v1/users/{user_id}/connectors/{connector_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
connector_id (required) | The unique identifier for the connector within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Connector membership has been deleted"
}
content_copy
List all group membershipslink
Returns all group membership objects for a user within your Fivetran account.
Requestlink
GET https://api.fivetran.com/v1/users/{user_id}/groups
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Query parameterslink
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 |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"items": [
{
"id": "group_id_1",
"role": "Destination Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
},
{
"id": "group_id_2",
"role": "Destination Reviewer",
"created_at": "2020-05-25T15:26:47.306509Z"
}
],
"next_cursor": "eyJza2lwIjoxfQ"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
items | The collection of group memberships |
item.id | The group unique identifier |
item.role | The role the user has within the group |
item.created_at | The date and time the membership was created |
next_cursor | The value of the cursor parameter for the next page |
Retrieve group membershiplink
Returns a group membership object.
Requestlink
GET https://api.fivetran.com/v1/users/{user_id}/groups/{group_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
group_id (required) | The unique identifier for the group within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"data": {
"id": "group_id",
"role": "Destination Administrator",
"created_at": "2020-05-25T15:26:47.306509Z"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
data.id | The group unique identifier |
data.role | The role the user has within the group |
data.created_at | The date and time the membership was created |
Add group membershiplink
Adds a group membership.
Requestlink
POST https://api.fivetran.com/v1/users/{user_id}/groups
{
"id": "group_id",
"role": "Destination Administrator"
}
content_copy
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
Payload parameterslink
Name | Description |
---|---|
id (required) | The unique identifier for the group within the account. |
role (required) | The role that you would like to assign to the user within the group. Possible values: Destination Administrator , Destination Analyst , Destination Reviewer , Connector Creator , or a custom role with destination level permissions. |
Responselink
HTTP 201 CREATED
{
"code": "Created",
"message": "Group membership has been created",
"data": {
"id": "group_id",
"role": "Destination Administrator",
"created_at": "2021-09-29T10:50:51.397153Z"
}
}
content_copy
Fieldslink
Name | Description |
---|---|
data.id | The group unique identifier |
data.role | The role the user has within the group |
data.created_at | The date and time the membership was created |
Update group membershiplink
Updates group membership.
Requestlink
PATCH https://api.fivetran.com/v1/users/{user_id}/groups/{group_id}
{
"role": "Destination Administrator"
}
content_copy
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
group_id (required) | The unique identifier for the group within the account. |
Payload parameterslink
Name | Description |
---|---|
role (required) | The role that you would like to assign to the user within the group. Possible values: Destination Administrator , Destination Analyst , Destination Reviewer , Connector Creator , or a custom role with destination level permissions. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Group membership has been updated"
}
content_copy
Delete group membershiplink
Removes group membership.
Requestlink
DELETE https://api.fivetran.com/v1/users/{user_id}/groups/{group_id}
Path parameterslink
Name | Description |
---|---|
user_id (required) | The unique identifier for the user within the account. |
group_id (required) | The unique identifier for the group within the account. |
Responselink
HTTP 200 OK
{
"code": "Success",
"message": "Group membership has been deleted"
}
content_copy