group_memberships

Creates, updates, deletes, gets or lists a group_memberships resource.

Overview

Name	group_memberships
Type	Resource
Id	fivetran.users.group_memberships

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	The membership entity unique identifier (example: resource_id)
created_at	string (date-time)	The timestamp that the user created their Fivetran account (example: 2024-01-01T00:00:00Z)
role	string	The role the user has within the entity (example: Role Title)

list

Name	Datatype	Description
id	string	The membership entity unique identifier (example: resource_id)
created_at	string (date-time)	The timestamp that the user created their Fivetran account (example: 2024-01-01T00:00:00Z)
role	string	The role the user has within the entity (example: Role Title)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, group_id		Returns details of a user membership in group.
list	select	user_id	cursor, limit	Returns the membership details for all groups a user belongs to.
create	insert	user_id, id, role		Adds a user membership in a group.
update	update	user_id, group_id, role		Updates user group membership.
delete	delete	user_id, group_id		Removes user from a group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
group_id	string	The unique identifier for the group within the Fivetran system.
user_id	string	The unique identifier for the user within the account.
cursor	string	Paging cursor, [read more about pagination](https:​//fivetran.com/docs/rest-api/pagination)
limit	integer (int32)	Number of records to fetch per page. Accepts a number in the range 1..1000; the default value is 100.

SELECT examples

get

Returns details of a user membership in group.

SELECT
id,
created_at,
role
FROM fivetran.users.group_memberships
WHERE user_id = '{{ user_id }}' -- required
AND group_id = '{{ group_id }}' -- required
;

list

Returns the membership details for all groups a user belongs to.

SELECT
id,
created_at,
role
FROM fivetran.users.group_memberships
WHERE user_id = '{{ user_id }}' -- required
AND "limit" = '{{ limit }}'
;

INSERT examples

create

Adds a user membership in a group.

INSERT INTO fivetran.users.group_memberships (
id,
role,
user_id
)
SELECT 
'{{ id }}' /* required */,
'{{ role }}' /* required */,
'{{ user_id }}'
RETURNING
id,
created_at,
role
;

Manifest

# Description fields are for documentation purposes
- name: group_memberships
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the group_memberships resource.
  - name: id
    value: "{{ id }}"
    description: |
      The membership entity unique identifier
  - name: role
    value: "{{ role }}"
    description: |
      The role that you would like to assign to the user

UPDATE examples

update

Updates user group membership.

UPDATE fivetran.users.group_memberships
SET 
role = '{{ role }}'
WHERE 
user_id = '{{ user_id }}' --required
AND group_id = '{{ group_id }}' --required
AND role = '{{ role }}' --required
RETURNING
code,
message;

DELETE examples

delete

Removes user from a group.

DELETE FROM fivetran.users.group_memberships
WHERE user_id = '{{ user_id }}' --required
AND group_id = '{{ group_id }}' --required
;