OrganizationInvitation

The OrganizationInvitation object is the model around an organization invitation.

Properties

OrganizationCustomRoleKey

OrganizationCustomRoleKey is a string that represents the user's role in the organization. Clerk provides the default roles org:admin and org:member. However, you can create custom roles as well.

Methods

revoke()

Revokes the invitation for the email it corresponds to.

function revoke(): Promise<OrganizationInvitation>

Example

The following example demonstrates how to revoke an organization invitation. It first gets the list of organization invitations using getInvitations() and then revokes the first invitation in the list.

It assumes:

• you have followed the quickstart in order to add Clerk to your JavaScript application

• you have enabled the Organizations feature in your Clerk Dashboard

  import { Clerk } from '@clerk/clerk-js'
  
  const pubKey = import.meta.env.VITE_CLERK_PUBLISHABLE_KEY
  
  const clerk = new Clerk(pubKey)
  await clerk.load()
  
  if (clerk.user) {
    // Check for an active organization
    if (clerk.organization) {
      // Get list of organization invitations
      const { totalCount, data } = await clerk.organization.getInvitations()
  
      const invitations = data
      console.log(`Invitations:`, invitations)
  
      if (invitations.length === 0) {
        console.log('No invitations to revoke.')
      }
  
      // Revoke the first invitation in the list
      invitations[0]
        .revoke()
        .then((res) => console.log(res))
        .catch((error) => console.log(error.errors))
    } else {
      // If there is no active organization,
      // mount Clerk's <OrganizationSwitcher />
      // to allow the user to set an organization as active
      document.getElementById('app').innerHTML = `
        <h2>Select an organization to set it as active</h2>
        <div id="org-switcher"></div>
      `
  
      const orgSwitcherDiv = document.getElementById('org-switcher')
  
      clerk.mountOrganizationSwitcher(orgSwitcherDiv)
    }
  } else {
    document.getElementById('app').innerHTML = `
      <div id="sign-in"></div>
    `
  
    const signInDiv = document.getElementById('sign-in')
  
    clerk.mountSignIn(signInDiv)
  }