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.
| 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
| Category | Endpoint | Description |
|---|---|---|
| List | GET /v1/groups | Returns a paginated list of all groups in the account. |
| Create | POST /v1/groups | Creates a new group. |
| Retrieve | GET /v1/groups/{groupId} | 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. |
| List connections | GET /v1/groups/{groupId}/connections | Returns a list of all connections in the group. |
| Retrieve public key | GET /v1/groups/{groupId}/public-key | Returns the public SSH key associated with the group. |
| Retrieve service account | GET /v1/groups/{groupId}/service-account | Returns the Fivetran service account associated with the group. |
| List users | GET /v1/groups/{groupId}/users | Returns a list of all users in the group. |
| Add user | POST /v1/groups/{groupId}/users | Adds a user to the group. |
| Remove user | DELETE /v1/groups/{groupId}/users/{userId} | Removes a user from the group. |