Group
Represents a group in your Fivetran account. Groups are organizational units that contain connections and users. Each group has its own SSH key pair and service account, which are used when configuring connections that require key-based or service account authentication.
Resource attributes
The following attributes describe a group.
View attribute definitions
| Field name | Type | Description |
|---|---|---|
id | string, read-only | Unique identifier of the group. |
name | string | Name of the group. |
created_at | string, read-only | Date and time the group was created, in ISO 8601 format. |
Supported operations
Once you have access to the Fivetran API, you can perform the following operations on the group resource.
| Category | Endpoint | Description |
|---|---|---|
| Create | POST /v1/groups | Creates a new group. |
| Read | - GET /v1/groups- GET /v1/groups/{groupId} | - Returns a paginated list of all groups in the account. - Returns the details of a group. |
| Update | PATCH /v1/groups/{groupId} | Updates the name of an existing group. |
| Delete | DELETE /v1/groups/{groupId} | Deletes a group. |
| Connections | GET /v1/groups/{groupId}/connections | Returns a list of all connections in the group. |
| SSH key | GET /v1/groups/{groupId}/public-key | Returns the public SSH key associated with the group. |
| Service account | GET /v1/groups/{groupId}/service-account | Returns the Fivetran service account associated with the group. |
| User management | - GET /v1/groups/{groupId}/users- POST /v1/groups/{groupId}/users- DELETE /v1/groups/{groupId}/users/{userId} | - Returns a list of all users in the group. - Adds a user to the group. - Removes a user from the group. |