Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.dev

OrganizationInvitation

Overview

The OrganizationInvitation object is the model around an organization invitation.

Attributes

NameTypeDescription
idstring

A unique identifier for this organization membership.

emailAddressstring

The email address the invitation has been sent.

organizationIdstring

The organization id of the organization this invitation is for.

roleMembershipRole

The role of the current user in the organization.

statusOrganizationInvitationStatus

The status of the invitation.

createdAtDate

Date of the time the membership was created.

updatedAtDate

Date of the last time the membership was updated.

Methods

revoke()

revoke()=>Promise<OrganizationInvitationResource>

Revokes the invitation for the email it corresponds to.

Was this helpful?

Clerk © 2022