Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

OrganizationInvitation

The OrganizationInvitation object is the model around an organization invitation.

Properties

NameTypeDescription
idstringA unique identifier for this organization membership.
emailAddressstringThe email address the invitation has been sent.
organizationIdstringThe organization ID of the organization this invitation is for.
publicMetadataobjectThe public metadata of the organization membership.
role'admin' | 'basic_member' | 'guest_member'The role of the current user in the organization.
status'pending' | 'accepted' | 'revoked'The status of the invitation.
createdAtDateDate of the time the membership was created.
updatedAtDateDate of the last time the membership was updated.

Methods

revoke()

function revoke(): Promise<OrganizationInvitation>;

Revokes the invitation for the email it corresponds to.

Returns

TypeDescription
Promise<OrganizationInvitation>This method returns a Promise which resolves to the OrganizationInvitation for the revolked invitation.

Last updated on October 10, 2023

What did you think of this content?

Clerk © 2023