OrganizationInvitation
The OrganizationInvitation
object is the model around an organization invitation.
Properties
Name | Type | Description |
---|---|---|
id | string | A unique identifier for this organization membership. |
emailAddress | string | The email address the invitation has been sent. |
organizationId | string | The organization ID of the organization this invitation is for. |
publicMetadata | object | The public metadata of the organization membership. |
role | string | The role of the current user in the organization. |
status | 'pending' | 'accepted' | 'revoked' | The status of the invitation. |
createdAt | Date | Date of the time the membership was created. |
updatedAt | Date | Date of the last time the membership was updated. |
Methods
revoke()
function revoke(): Promise<OrganizationInvitation>;
Revokes the invitation for the email it corresponds to.
Returns
Type | Description |
---|---|
Promise<OrganizationInvitation> | This method returns a Promise which resolves to the OrganizationInvitation for the revolked invitation. |