Invites erstellen mit der API

Routen:

Zum erstellen der Links gibt es zwei Routen:
[POST] /Invite

Für diese Route benötigt man keine InstanzAdmin-Rechte, es wird allerdings überprüft ob man für die eingegeben Parameter überhaupt berechtigt ist.

[POST] /Invite/InstanceAdmin

Für diese Route benötigt man InstanzAdmin-Rechte. Hier können Einladungslinks ohne besondere Berechtigungen erstellt werden.

Mit dem Post erstellt man mit der API einen InviteLink.

Parameter:

[required] InstanceId
[optional] MailValidationType
[optional] ExpirationDate
[optional] TenantId
[optional] DomainRule

Beispiel JSON:

{
  "InstanceId": 1,
  "MailValidationType": "Domain",
  "DomainRule": "@example.org"
}

Beispiel Response:

{
	"id": 12,
	"entityType": "Invite",
	"domainRule": "@example.org",
	"mailValidationType": "Domain",
	"instanceId": 1,
	"inviteLink": "gWvpkmLBMpgd2zuxMuk0h4NYemPMby1nPn7lYwTnNAL0QazsxFAfGUX5_xWN3J87sWEV7fT3mcI7xpdbkIVUW_adRiGvbu4rsW4Sz-bmTyVxsY7tQQq1yl3Z6-FZJgrkIauxyMgr1lPvNxSUsv7tzETRIcpGc-zQ1Yqhpr5zfmW5pO7TW8ZwQq704-LrYtUH3lgXePbAD9GzCu7JjfbCuQ",
	"expirationDate": null,
	"erpId": null,
	"deleted": false,
	"tenantId": null,
	"createDate": "2024-02-15T13:36:26.6845915Z",
	"updateDate": "2024-02-15T13:36:26.6846302Z",
	"name": null
}

Wichtiger Parameter hier: inviteLink
Mit diesem string wird der Einladungslink gebildet. Beim Aufruf von [TW365-Url]/invite/[inviteLink] wird überprüft ob dieser Link gültig ist und wenn ja der User/Employee passend zum Invite angelegt oder verknüpft.