User

Represents a user in a Fivetran account.

Resource attributes

The following are the attributes of the user resource.

Lifecycle-related attributes

These fields help track the user’s lifecycle in the account.

Field name	Description
`verified` (`boolean`, read-only)	Indicates whether the user has completed account activation (`true`) or not (`false`).
`invited` (`boolean`, read-only)	Indicates whether the user has been invited but not yet accepted (`true`). This remains `true` until the user accepts the invite. After acceptance, it becomes `false`.
`active` (`boolean`, read-only)	Indicates whether the user is currently allowed to log in (`true` means the user is enabled, while `false` means the user has been suspended or deactivated by an admin).
`created_at` (`string` ISO-8601, read-only)	Timestamp when the user record was created.
`logged_in_at` (`string` ISO-8601)	Timestamp of the user’s last successful login.

The lifecycle boolean flags (active, invited, verified) change only through internal actions (suspension, invitation acceptance, email verification).

RBAC-related attributes

These fields determine authorization for account-wide actions like user management, billing, and resource creation.

Field name	Description
`role` (`string`)	Account-level role that determines default privileges. Allowed values: `Account Billing`, `Account Administrator`, `Account Analyst`, `Account Reviewer`, or any custom account-level role you’ve defined.

Identity and profile-related attributes

These fields identify the user and represent the profile details you can display in your Fivetran dashboard.

Field name	Description
`id` (`string`, read-only)	Unique ID of the user.
`email` (`string`, read-only)	Unique email address the user uses to log in.
`given_name` (`string`)	First name of the user.
`family_name` (`string`)	Last name of the user.
`picture` (`string`)	Avatar as a URL or Base64 data URI.
`phone` (`string`)	Phone number of the user.

Supported operations

Once you have access to the Fivetran API, you can perform the following operations on the user resource:

Category	Endpoint	Description
User provisioning	`POST /v1/users`	Creates the user resource.
Updates	`PATCH /v1/users/{userId}`	Resets given name, family name, phone number, picture, or default role for the user.
Deletion	`DELETE /v1/users/{userId}`	Permanently removes the user identity and its memberships.
Connection memberships	`POST /v1/users/{userId}/connections` `PATCH /v1/users/{userId}/connections/{connectionId}` `GET /v1/users/{userId}/connections` `GET /v1/users/{userId}/connections/{connectionId}` `DELETE /v1/users/{userId}/connections/{connectionId}`	Endpoints to add, update, fetch, or revoke the user’s role on individual connections.
Group memberships	`POST /v1/users/{userId}/groups` `PATCH /v1/users/{userId}/groups/{groupId}` `GET /v1/users/{userId}/groups` `GET /v1/users/{userId}/groups/{groupId}` `DELETE /v1/users/{userId}/groups/{groupId}`	Endpoints to add, update, fetch, or revoke the user’s role in groups.
Account access	`DELETE /v1/users/{userId}/role`	Revokes the user’s role in the account.
Listing and discovery	`GET /v1/users` `GET /v1/users/{userId}`	Returns the list of users and the full user object.