revokeOrganizationInvitation()
Revokes an OrganizationInvitation from a user for the specified organization.
function revokeOrganizationInvitation(
params: RevokeOrganizationInvitationParams,
): Promise<OrganizationInvitation>- Name
organizationId- Type
string- Description
The ID of the organization the user was invited to.
- Name
invitationId- Type
string- Description
The ID of the invitation to be revoked.
- Name
requestingUserId- Type
string- Description
The ID of the user revoking the organization invitation.
Example
In the following example, you can see that the returned OrganizationInvitation object has a status of 'revoked'.
const organizationId = 'org_123'
const invitationId = 'orginv_123'
const requestingUserId = 'user_123'
const response = await clerkClient.organizations.revokeOrganizationInvitation({
organizationId,
invitationId,
requestingUserId,
})
console.log(response)
/*
_OrganizationInvitation {
id: 'orginv_123',
emailAddress: 'testclerk123@gmail.com',
role: 'org:member',
organizationId: 'org_123',
createdAt: 1705538313485,
updatedAt: 1705538631145,
status: 'revoked',
publicMetadata: {},
privateMetadata: {}
}
*/Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint POST/organizations/{organization_id}/invitations/{invitation_id}/revoke. See the BAPI reference for more information.
Feedback
Last updated on