pyfivetran.endpoints.users

Module Contents

Classes

User

UserEndpoint

API

class pyfivetran.endpoints.users.User[source]

Bases: pyfivetran.endpoints.base.ApiDataclass

fivetran_id: str = None
email: str = None
verified: bool = None
role: str = None
active: bool = None
created_at: datetime.datetime = None
logged_in_at: datetime.datetime = None
family_name: Optional[str] = None
given_name: Optional[str] = None
invited: Optional[bool] = None
picture: Optional[str | bytes] = None
phone: Optional[str] = None
_is_deleted: bool = False
property as_url: str
property raw: Dict[str, Any]
property connector_memberships: Sequence[pyfivetran.shed.PaginatedApiResponse]

All connector memberships for a user.

Returns:

PaginatedApiResponse

property group_memberships: Sequence[pyfivetran.shed.PaginatedApiResponse]

All group memberships for a user.

Returns:

PaginatedApiResponse

delete() → pyfivetran.shed.GeneralApiResponse[source]

Deletes a user in your Fivetran account.

Returns:

GeneralApiResponse

add_connector_membership(connector_id: str, role: str) → pyfivetran.shed.GeneralApiResponse[source]

Add a connector membership.

Parameters:

  • connector_id – The id of the connector

  • role – The role of the user

Returns:

GeneralApiResponse

add_group_membership(group_id: str, role: str) → pyfivetran.shed.GeneralApiResponse[source]

Add a group membership.

Parameters:

  • group_id – The id of the group

  • role – The role of the user

Returns:

GeneralApiResponse

classmethod _from_dict(endpoint, d: Dict[str, Any]) → pyfivetran.endpoints.users.User[source]

Helper method for deserialzing from a dict.

Parameters:

d – The dict to deserialize

Returns:

The deserialized object

class pyfivetran.endpoints.users.UserEndpoint(client: pyfivetran.endpoints.base.Client)[source]

Bases: pyfivetran.endpoints.base.Endpoint

BASE_URL: str = None
invite_user(email: str, family_name: str, given_name: str, phone: Optional[str] = None, picture: Optional[str] = None, role: Optional[str] = None) → pyfivetran.endpoints.users.User[source]

Invite a user to your Fivetran account.

Parameters:

  • email – The email of the user

  • family_name – The family name of the user

  • given_name – The given name of the user

  • phone – The phone number of the user

  • picture – The picture of the user

  • role – The role of the user

Returns:

User

get_users(limit: Optional[int] = None) → Sequence[pyfivetran.endpoints.users.User][source]

Returns a list of all users within your Fivetran account.

Parameters:

limit – The number of records to return

Returns:

Sequence[User]