Module invitations_api

Module invitations_api 

Source

Enums§

CreateInvitationError
struct for typed errors of method create_invitation
ListInvitationsError
struct for typed errors of method list_invitations
RevokeInvitationError
struct for typed errors of method revoke_invitation

Functions§

create_invitation
Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
list_invitations
Returns all non-revoked invitations for your application, sorted by creation date
revoke_invitation
Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn’t prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.