URLParameterInformation

The URLParameterInformation type is used hold information about URL parameters that can be passed between the UX and APIs.

Below are the properties and their purpose.

• string URLParameters
  • Default Value: Empty string.
  • Intended Value: Contains the current URL parameters.
• string InstanceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of an instance used for deep linking.
• string WorkspaceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the workspace that the user is joining or is part of.
• string InviteUserGUID
  • Default Value: Empty Guid.
  • Intended Value: The join key used by a user when joining a workspace.
• string ActionName
  • Default Value: No Action.
  • Intended Value: The action to be performed on the URL parameters.
• string AuthenticationPageContent
  • Default Value: Empty string.
  • Intended Value: Contains the markup of the authentication page.
• string PortalGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the portal the user is joining.
• string ErrorMessage
  • Default Value: Empty string.
  • Intended Value: Contains an error message if something failed while processing the URL parameters so it can properly be handled.
• string UserGUID
  • Default Value: Empty Guid.
  • Intended Value: Not currently being used.
• string ToSButtonText
  • Default Value: Empty Guid.
  • Intended Value: The text of the Term of Service button during the sign up process.
• string ToSAcceptPrompt
  • Default Value: Empty string.
  • Intended Value: The accept prompt for the terms of service during the sign up process.
• string TermsOfService
  • Default Value: Empty string.
  • Intended Value: The terms of service that is visible during the sign up process.
• Guid DefaultJoinKey
  • Default Value: Empty Guid.
  • Intended Value: Used internally as part of joining a workspace.
• string IndexContent
  • Default Value: Empty string.
  • Intended Value: The HTML content for the index page.
• string IndexContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the content on the index page.
• string FooterContent
  • Default Value: Empty string.
  • Intended Value: The HTML content for the footer on the index page.
• string SignInContent
  • Default Value: Empty string.
  • Intended Value: The HTML content foe the sign in component.
• string SignInContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the sign in content when the sign in component is visible.
• string SignInUsernameLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Username label on the sign in component.
• string SignInPasswordLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Password label for the sign in component.
• string SignUpContent
  • Default Value: Empty string.
  • Intended Value: The HTML content for the sign up component.
• string SignUpContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the sign up content when the sign up component is visible.
• string SignUpSecondaryMFAHTML
  • Default Value: Empty string.
  • Intended Value: The HTML content displayed for adding a secondary MFA target during the sign up process.
• string SignUpEmailAddressLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Email Address label on the sign up component.
• string SignUpConfirmEmailAddressLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Confirm Email Address label on the sign up component.
• string SignUpEmailVerifiedLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Email Verified label on the sign up component.
• string SignUpEmailVerifiedIconClass
  • Default Value: Empty string.
  • Intended Value: The font awesome class for the Email Verified icon on the sign up component.
• string SignUpPasswordLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Password label on the sign up component.
• string SignUpConfirmPasswordLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Confirm Password label on the sign up component.
• string SignUpFirstNameLabel
  • Default Value: Empty string.
  • Intended Value: The text for the First Name label on the sign up component.
• string SignUpLastNameLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Last Name label on the sign up component.
• string SignUpSecurityQuestionLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Security Question label on the sign up component.
• string SignUpSecurityAnswerLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Security Answer label on the sign up component.
• string ResetPasswordContent
  • Default Value: Empty string.
  • Intended Value: The HTML content for the reset password component.
• string ResetPasswordContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the reset password content when the component is visible.
• string ResetPasswordNewPWLabel
  • Default Value: Empty string.
  • Intended Value: The text for the New Password label on the reset password component.
• string ResetPasswordConfirmPWLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Confirm Password label on the reset password component.
• string ResetPasswordSecurityAnswerLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Security Answer label on he reset password component.
• string ResetPasswordEnterEmailLabel
  • Default Value: Empty string.
  • Intended Value: The text for the Enter Email label on the reset password component.
• string JoinWorkspaceContent
  • Default Value: Empty string.
  • Intended Value: The HTML content for the join workspace page.
• string JoinWorkspaceContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the join workspace content from the landing page configuration.
• string WorkspacesContent
  • Default Value: Empty Guid.
  • Intended Value: The HTML content of the workspaces page.
• string WorkspacesContentPosition
  • Default Value: Empty string.
  • Intended Value: The position of the workspaces content from the landing page configuration.
• string CSSClasses
  • Default Value: Empty string.
  • Intended Value: The CSS classes for the landing page configuration.
• Guid LandingPageConfigurationKey
  • Default Value: Empty Guid.
  • Intended Value: The Guid of the landing page configuration to load.