Invites

TagmeClientAdvanced.accept_invite(invite_id: str, pools: List[str], organization_id: str | None = None, ) → None

Approve request to join organization.

Parameters

* invite_id – invite id to approve.

* pools – list of pools to add user to.

* organization_id – optional organization identifier. Defaults to None.

TagmeClientAdvanced.create_invite(data: InviteRequest, ) → InviteData

Create new invite to organization.

Parameters data – invite request data.

Returns

created invite data.

TagmeClientAdvanced.create_invite_request(invite_id: str, organization_id: str | None = None, ) → InviteApplication

Create request to join organization.

Parameters

* invite_id – invite id.

* organization_id – optional organization identifier. Defaults to None.

Returns

invite request data.

TagmeClientAdvanced.delete_invite(uid: str, organization_id: str | None = None, ) → InviteData

Delete invite.

Parameters

* uid – invite id.

* organization_id – optional organization identifier. Defaults to None.

Returns

full information about deleted invite.

TagmeClientAdvanced.get_invite(uid: str, organization_id: str | None = None, ) → InviteData

Get invite by its id.

Parameters

* uid – invite id.

* organization_id – optional organization identifier. Defaults to None.

Returns

full information about invite.

TagmeClientAdvanced.get_invites(active: bool = True, page: int | None = None, size: int | None = None, organization_id: str | None = None, ) → List[InviteData]

Get invites.

Parameters

* active – get only active invites. Defaults to True.

* page – page number for pagination. Defaults to None.

* size – page size for pagination. Defaults to None.

* organization_id – optional organization identifier. Defaults to None.

Returns

list of invites.

TagmeClientAdvanced.get_invites_pending(organization_id: str | None = None, invite_name: str | None = None, state: str = 'NEW', ) → List[InviteApplication]

Get all the requests to join organization.

Parameters

* organization_id – optional organization identifier. Defaults to None.

* invite_name – filter by invite name. Defaults to None.

* state – filter by state. Defaults to ‘NEW’.

Returns

all the requests to join organization.

TagmeClientAdvanced.put_invite(data: InviteData, ) → InviteData

Add new invite to organization.

Parameters data – invite data to create it.

Returns

full information about created invite.