invites

cloud.invites

Functions

Name	Description
accept_invitation	Accept an invitation.
cancel_invite_to_array	Cancels array sharing invitation.
cancel_invite_to_group	Cancels group sharing invitation.
cancel_invite_to_organization	Cancels join organization invitation.
fetch_invitations	Fetches a paginated list of invitations.
invite_to_array	Share array by email invite.
invite_to_group	Sends email to multiple recipients with sharing information regarding a group.
invite_to_organization	Sends email to multiple recipients with joining information

accept_invitation

cloud.invites.accept_invitation(invitation_id)

Accept an invitation.

Parameters

Name	Type	Description	Default
invitation_id	str	the ID of invitation about to be accepted.	required

Returns

Name	Type	Description
	None	None

cancel_invite_to_array

cloud.invites.cancel_invite_to_array(uri, *, invitation_id)

Cancels array sharing invitation.

Parameters

Name	Type	Description	Default
uri	str	URI of array in the form ‘tiledb:///’	required
invitation_id	str	the ID of invitation about to be canceled.	required

Returns

Name	Type	Description
	None	None

cancel_invite_to_group

cloud.invites.cancel_invite_to_group(uri, *, invitation_id)

Cancels group sharing invitation.

Parameters

Name	Type	Description	Default
uri	str	URI of group in the form ‘tiledb:///’	required
invitation_id	str	the ID of invitation about to be canceled.	required

Returns

Name	Type	Description
	None	None

cancel_invite_to_organization

cloud.invites.cancel_invite_to_organization(organization, *, invitation_id)

Cancels join organization invitation.

Parameters

Name	Type	Description	Default
organization	str	name or UUID of organization.	required
invitation_id	str	the ID of invitation about to be canceled.	required

Returns

Name	Type	Description
	None	None

fetch_invitations

cloud.invites.fetch_invitations(**filters)

Fetches a paginated list of invitations.

Parameters

Name	Type	Description	Default
organization	str	name or ID of organization to filter	required
array	str	name/uri of array that is url-encoded to filter	required
group	str	name or ID of group to filter	required
start	int	start time for tasks to filter by	required
end	int	end time for tasks to filter by	required
page	int	pagination offset	required
per_page	int	pagination limit	required
type	str	invitation type, “ARRAY_SHARE”, “JOIN_ORGANIZATION”	required
status	str	Filter to only return “PENDING”, “ACCEPTED”	required
orderby	str	sort by which field valid values include timestamp, array_name, organization_name	required

Returns

Name	Type	Description
		Invitations and pagination metadata.

invite_to_array

cloud.invites.invite_to_array(uri, *, recipients, actions)

Share array by email invite.

Parameters

Name	Type	Description	Default
uri	str	URI of array in the form ‘tiledb:///’	required
recipients	Sequence[str]	list of recipient emails/usernames.	required
actions	Sequence[str]	list of ArrayActions allowed to the recipient.	required

Returns

Name	Type	Description
	None	None

invite_to_group

cloud.invites.invite_to_group(uri, *, recipients, array_actions, group_actions)

Sends email to multiple recipients with sharing information regarding a group.

Parameters

Name	Type	Description	Default
uri	str	URI of group in the form ‘tiledb:///’	required
recipients	Sequence[str]	list of recipient emails/usernames.	required
array_actions	Sequence[str]	list of ArrayActions allowed to the recipient.	required
group_actions	Sequence[str]	list of GroupActions allowed to the recipient.	required

Returns

Name	Type	Description
	None	None

invite_to_organization

cloud.invites.invite_to_organization(
    organization,
    *,
    recipients,
    role,
    actions=None,
)

Sends email to multiple recipients with joining information regarding an organization.

Parameters

Name	Type	Description	Default
organization	str	name or UUID of organization.	required
recipients	Sequence[str]	list of recipient emails/usernames.	required
role	str	role assigned to the recipient.	required
actions	Optional[Sequence[str]]	an optional sequence of actions.	None

Returns

Name	Type	Description
	None	None