UserInformation

The UserInformation type is used hold information about a user that can be passed between the UX and APIs.

Below are the properties and their purpose.

• string CommandName
  • Default Value: Empty string.
  • Intended Value: The command to be executed when making an API call.
• Guid SessionGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the users active session.
• Guid UserGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the current user.
• string ErrorMessage
  • Default Value: Empty string.
  • Intended Value: Contains an error message if something failed during an API call so it can be properly handled in the UX.
• string FirstName
  • Default Value: Empty string.
  • Intended Value: The first name of the user.
• string LastName
  • Default Value: Empty string.
  • Intended Value: The last name of the user.
• Guid UserProfileGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the users user-profile.
• string UserProfileName
  • Default Value: Empty string.
  • Intended Value: The users user-profile name.
• string Password
  • Default Value: Empty string.
  • Intended Value: The password of the user.
• string NewPassword
  • Default Value: Empty string.
  • Intended Value: The new password for the user when changing passwords.
• bool IsAuthenticated
  • Default Value: false.
  • Intended Value: Determines if the user is currently authenticated.
• Guid WorkspaceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the workspace the user belongs to.
• string WorkspaceName
  • Default Value: Empty string.
  • Intended Value: The name of the workspace the user belongs to.
• string Username
  • Default Value: Empty string.
  • Intended Value: The users username.
• string Workspaces
  • Default Value: Empty string.
  • Intended Value: Contains a list of workspaces the user has access to in XML.
• string Language
  • Default Value: Empty string.
  • Intended Value: The language of the user.
• string PortalName
  • Default Value: Empty string.
  • Intended Value: The name of the portal that the user belongs to.
• string DefaultApplication
  • Default Value: Empty string.
  • Intended Value: The name of the default application that’s loaded when the user logs into the portal/workspace.
• Guid DefaultApplicationGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the users default application that’s loaded when they access a portal/workspace.
• bool CollapseLeftNavigation
  • Default Value: false.
  • Intended Value: Determines if the left navigation is currently collapsed.
• DateTime LocalTimeAtSignIn
  • Default Value: The current datetime.
  • Intended Value: Contains the date and time that the user signed in, in their local time.
• string SecurityQuestion
  • Default Value: Empty string.
  • Intended Value: The users security question.
• string SecurityAnswer
  • Default Value: Empty string.
  • Intended Value: The answer to the users security question.
• string UserApps
  • Default Value: Empty string.
  • Intended Value: Contains a list of applications the user has access to in XML.
• string UserRoles
  • Default Value: Empty string.
  • Intended Value: Contains a list of roles the user has in XML.
• string Bookmarks
  • Default Value: Empty string.
  • Intended Value: Contains a list of bookmarks that the user has in XML.
• string ServerConfiguration
  • Default Value: Empty string.
  • Intended Value: Contains a list of server configuration parameters the user has in XML.
• string WorkspaceConfiguration
  • Default Value: Empty string.
  • Intended Value: Contains a list of workspace configuration parameters the user has in XML.
• string UserConfiguration
  • Default Value: Empty string.
  • Intended Value: Contains a list of user configuration parameters the user has in XML.
• bool Descriptions
  • Default Value: true.
  • Intended Value: Determines if field descriptions will be visible.
• string ConfigKey
  • Default Value: Empty string.
  • Intended Value: The key of a configuration that’s being updated.
• string ConfigValue
  • Default Value: Empty string.
  • Intended Value: The value of a configuration that’s being updated.
• string DefaultApplicationIconType
  • Default Value: Empty string.
  • Intended Value: The icon type used for the default application.
• string DefaultApplicationIcon
  • Default Value: Empty string.
  • Intended Value: The icon for the default application, either a class name or URL.
• Guid DeepLinkGUID
  • Default Value: Empty Guid.
  • Intended Value: Currently not being used.
• string JoinAction
  • Default Value: Empty string.
  • Intended Value: Currently not being used.
• string JoinKey
  • Default Value: Empty string.
  • Intended Value: The join key used by the user when joining a workspace/portal.
• Guid InviteUserGUID
  • Default Value: Empty Guid.
  • Intended Value: Contains the guid needed to join a workspace/portal which is pulled from the JoinKey.
• Guid PortalGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of the portal the user is attempting to join.
• Guid PortalInstanceGUID
  • Default Value: Empty Guid.
  • Intended Value: The guid of an existing portal for the user to join or enter.
• string JoinedContent
  • Default Value: Empty string.
  • Intended Value: Markup that is intended to be displayed once the user successfully joined a workspace and is an inactive user.
• string CheckBoxText
  • Default Value: Empty string.
  • Intended Value: Contains the checkbox marketing text for the JoinWorkspace component.
• string JoinPage
  • Default Value: Empty string.
  • Intended Value: Contains the markup displayed on the join page when joining a workspace.
• bool HasUserInWorkspace
  • Default Value: false.
  • Intended Value: Determines if the user is already part of the workspace they’re attempting to join.
• string JoinPageBottomHTML
  • Default Value: Empty string.
  • Intended Value: Contains the markup displayed at the bottom of the join page.
• string JoinExistingPage
  • Default Value: Empty string.
  • Intended Value: Contains the markup on the join page if the user is joining an existing portal.
• string JoinExistingButtonText
  • Default Value: Empty string.
  • Intended Value: Contains the text displayed on the join button when joining an existing portal.
• string UserState
  • Default Value: Empty string.
  • Intended Value: The current state of the user.
• bool ValidDeepLink
  • Default Value: false.
  • Intended Value: Currently not being used.
• bool JoinLinkCheckbox
  • Default Value: false.
  • Intended Value: Determines if the user subscribed to marketing emails on the join page.
• bool ValidReset
  • Default Value: false.
  • Intended Value: Determines if the attempted password reset was successful.
• string PortalStringValue
  • Default Value: Empty string.
  • Intended Value: Contains the text displaed above the join portal button on the join page.
• string PortalStringElementName
  • Default Value: Empty string.
  • Intended Value: Contains the name of the portal string element.
• string PortalStringValue
  • Default Value: Empty string.
  • Intended Value: Contains the organization name of the customer creating the portal.
• string ResetCode
  • Default Value: Empty string.
  • Intended Value: Currently Not being used.
• string ResetPasswordMode
  • Default Value: Empty string.
  • Intended Value: Contains the method the user would like to use to reset their password.
• string JoinButtonText
  • Default Value: Empty string.
  • Intended Value: Contains the text displayed on the join button when joining a workspace.
• bool UserJoining
  • Default Value: false.
  • Intended Value: Currently not being used.
• bool SignUpRequired
  • Default Value: false.
  • Intended Value: Currently not being used.
• bool Reset
  • Default Value: false.
  • Intended Value: Currently not being used.
• int InfoAlerts
  • Default Value: 0.
  • Intended Value: Contains the number of pending info alerts the user has.
• int RedAlerts
  • Default Value: 0.
  • Intended Value: Contains the number of pending red alerts the user has.
• string AllTopics
  • Default Value: Empty string.
  • Intended Value: Contains a list all the users topics in XML.
• string UserTopics
  • Default Value: Empty string.
  • Intended Value: Contains a list of user topics the user has selected in XML.
• string Theme
  • Default Value: Light.
  • Intended Value: The current theme the user is using.
• string WorkspaceFooterText
  • Default Value: Empty string.
  • Intended Value: The markup that’s displayed in the footer of the workspace.