UserOrganizationInvitation
The UserOrganizationInvitation object is the model around a user's invitation to an organization.
Properties
- Name
id- Type
string- Description
The unique identifier for this organization invitation.
- Name
emailAddress- Type
string- Description
The email address the invitation has been sent to.
- Name
publicOrganizationData- Type
{ hasImage: boolean; imageUrl: string; name: string; id: string; slug: string | null; }- Description
The public data of the organization.
hasImage: Whether the organization has an image.imageUrl: Holds the organization logo. Compatible with Clerk's Image Optimization.name: The name of the organization.id: The ID of the organization.slug: The slug of the organization.
- Name
publicMetadata- Type
- UserOrganizationInvitationPublicMetadata
- Description
The public metadata of the organization invitation.
- Name
role- Type
- OrganizationCustomRoleKey
- Description
The role of the current user in the organization.
- Name
status- Type
'pending' | 'accepted' | 'revoked'- Description
The status of the invitation.
- Name
createdAt- Type
Date- Description
The date when the invitation was created.
- Name
updatedAt- Type
Date- Description
The date when the invitation was last updated.
function accept(): Promise<UserOrganizationInvitation>Example
To see an example of how to use the accept() method, see the custom flow guide for managing invitations.
Feedback
Last updated on