Package org.keycloak.models

Interface OrganizationInvitationModel

All Known Implementing Classes:
OrganizationInvitationEntity
public interface OrganizationInvitationModel
Model representing an organization invitation.

  • Method Details

    • getId

      String getId()
      Returns the unique identifier of this invitation.
      Returns:
      the unique identifier

    • getOrganizationId

      String getOrganizationId()
      Returns the organization ID this invitation belongs to.
      Returns:
      the organization ID

    • getEmail

      String getEmail()
      Returns the email address of the invited user.
      Returns:
      the email address

    • setEmail

      void setEmail(String email)
      Sets the email address of the invited user.
      Parameters:
      email - the email address

    • getFirstName

      String getFirstName()
      Returns the first name of the invited user.
      Returns:
      the first name

    • setFirstName

      void setFirstName(String firstName)
      Sets the first name of the invited user.
      Parameters:
      firstName - the first name

    • getLastName

      String getLastName()
      Returns the last name of the invited user.
      Returns:
      the last name

    • setLastName

      void setLastName(String lastName)
      Sets the last name of the invited user.
      Parameters:
      lastName - the last name

    • getCreatedAt

      int getCreatedAt()
      Returns the timestamp when this invitation was created.
      Returns:
      the creation timestamp

    • getExpiresAt

      int getExpiresAt()
      Returns the timestamp when this invitation expires.
      Returns:
      the expiration timestamp, or null if no expiration

    • setExpiresAt

      void setExpiresAt(int expiresAt)
      Sets the timestamp when this invitation expires.
      Parameters:
      expiresAt - the expiration timestamp

    • getInviteLink

      String getInviteLink()
      Returns the invitation link.
      Returns:
      the invitation link

    • setInviteLink

      void setInviteLink(String inviteLink)
      Sets the invitation link.
      Parameters:
      inviteLink - the invitation link

    • getStatus

      OrganizationInvitationModel.InvitationStatus getStatus()
      Returns the current status of this invitation.
      Returns:
      the invitation status

    • isExpired

      default boolean isExpired()
      Returns whether this invitation has expired.
      Returns:
      true if expired, false otherwise