Package com.auth0.json.mgmt.organizations

Class Invitation

java.lang.Object
com.auth0.json.mgmt.organizations.Invitation
public class Invitation extends Object
Represents the Invitation object for an organization.
See Also:

  • Constructor Details

    • Invitation

      public Invitation(Inviter inviter, Invitee invitee, String clientId)
      Create a new instance.
      Parameters:
      inviter - the Inviter of this invitation.
      invitee - the Invitee of this invitation.
      clientId - Auth0 client ID. Used to resolve the application's login initiation endpoint.

  • Method Details

    • getId

      public String getId()
      Returns:
      the ID of this invitation.

    • getInviter

      public Inviter getInviter()
      Returns:
      the Inviter of this invitation.

    • getInvitee

      public Invitee getInvitee()
      Returns:
      the Invitee of this invitation.

    • getTtlInSeconds

      public Integer getTtlInSeconds()
      Returns:
      the number of seconds before this invitation expires.

    • setTtlInSeconds

      public void setTtlInSeconds(Integer ttlInSeconds)
      Sets the number of seconds before this invitation expires. If unspecified or set to 0, this value defaults to 604800 seconds (7 days). Max value: 2592000 seconds (30 days).
      Parameters:
      ttlInSeconds - the number of seconds before this invitation expires.

    • getClientId

      public String getClientId()
      Returns:
      the client ID of this invitation.

    • getConnectionId

      public String getConnectionId()
      Returns:
      the connection ID of this invitation.

    • setConnectionId

      public void setConnectionId(String connectionId)
      Sets the ID of the connection for the inviter to authenticate with.
      Parameters:
      connectionId - the ID of the connection.

    • getAppMetadata

      public Map<String,Object> getAppMetadata()
      Returns:
      the app metadata of this invitation.

    • setAppMetadata

      public void setAppMetadata(Map<String,Object> appMetadata)
      Sets the app metadata associated with this invitation.
      Parameters:
      appMetadata - the app metadata.

    • getUserMetadata

      public Map<String,Object> getUserMetadata()
      Returns:
      the user metadata of this invitation.

    • setUserMetadata

      public void setUserMetadata(Map<String,Object> userMetadata)
      Sets the user metadata associated with this invitation.
      Parameters:
      userMetadata - the user metadata.

    • isSendInvitationEmail

      public Boolean isSendInvitationEmail()
      Returns:
      whether the user will receive an invitation email (true) or no email (false).

    • setSendInvitationEmail

      public void setSendInvitationEmail(Boolean sendInvitationEmail)
      Whether the user will receive an invitation email (true) or no email (false). If not specified, default value is true.
      Parameters:
      sendInvitationEmail - whether to send the user an invitation email or not.

    • getCreatedAt

      public Date getCreatedAt()
      Returns:
      the date this invitation was created at.

    • getExpiresAt

      public Date getExpiresAt()
      Returns:
      the date this invitation expires.

    • getTicketId

      public String getTicketId()
      Returns:
      the ID of the invitation ticket.

    • getRoles

      public Roles getRoles()
      Returns:
      the roles associated with the user invited.

    • setRoles

      public void setRoles(Roles roles)
      Sets the roles to be associated with the user invited.
      Parameters:
      roles - the Roles to associated with the user invited.

    • getInvitationUrl

      public String getInvitationUrl()
      Returns:
      the invitation url to be send to the invitee.

    • getOrganizationId

      public String getOrganizationId()
      Returns:
      the ID of the organization for this invitation.