The Backend OrganizationInvitation object
The Backend OrganizationInvitation object is similar to the OrganizationInvitation object as it is the model around an organization invitation. However, the Backend OrganizationInvitation object is different in that it is used in the Backend API and is not directly accessible from the Frontend API.
Properties
- Name
id- Type
string- Description
The unique identifier for the
OrganizationInvitation.
- Name
emailAddress- Type
string- Description
The email address of the user who is invited to the
Organization.
- Name
role- Type
string- Description
The role of the invited user.
- Name
organizationId- Type
string- Description
The ID of the
Organizationthat the user is invited to.
- Name
createdAt- Type
number- Description
The date when the invitation was first created.
- Name
updatedAt- Type
number- Description
The date when the invitation was last updated.
- Name
status?- Type
'pending' | 'accepted' | 'revoked'- Description
The status of the invitation.
- Name
publicMetadata- Type
OrganizationInvitationPublicMetadata- Description
Metadata that can be read from the Frontend API and Backend API and can be set only from the Backend API.
- Name
privateMetadata- Type
OrganizationInvitationPrivateMetadata- Description
Metadata that can be read and set only from the Backend API.
Feedback
Last updated on