Communicates properties of the user session to create for a CreateUserSessionWithParams call.

Fields

AuthorizationType

An enumerated type representing the type of authorization that the created session will have.  Valid values are:

normalLogin	The user is free to access Firmwater LMS as her role and access allows.
passwordReset	The user will be required to change his or her password immediately and then will be free to access the system as her role and access allows.
activityService	The user is only authorized to access the activity specified.  Value is only valid if EntryPointItemId is specified or ExternalActivityId is specified and is non-empty.
itemService	The user is only authorized to access the item specified.  Value is only valid if EntryPointItemId is specified or both ExternalActivityId and ExternalItemId are specified and non-empty.

EntryPointItemId

The 36-character globally unique identifier of the item to direct the user to (see LmsItemObject's Id field).  If this field is specified and non-empty, the ExternalActivityId and ExternalItemId fields are ignored.

ExternalActivityId

A string representing the external identifier of the activity to direct the user to (see LmsItemObject's ExternalItemId field).  Activities are container items such as courses that show at the top level of a user's training plan.  If two or more activities exist for the user's licensee with the same external identifier, the most recently created one is used.

This field is ignored if EntryPointItemId is specified and is non-empty.

ExternalItemId

An optional string representing the external identifier of the item within an activity to direct the user to (see LmsItemObject's ExternalItemId field).  This field is ignored if EntryPointItemId is specified and is non-empty.

ReturnUrl

A string representing the URL to redirect the user to on logout.  The URL is not checked to ensure that it is valid.  If ReturnUrl is not supplied or is empty, default processing occurs (user is returned to the referring page if referrer exists, otherwise, the login page).

TimeoutUrl

A string representing the URL to redirect the user to when they try to access a session that has timed out.  The URL is not checked to ensure that it is valid.  If TimeoutUrl is not supplied or is empty, default processing occurs (user is redirected to the login page with a message indicating that their session timed out).

ErrorUrl

A string representing the URL to redirect the user to when an unhandled error occurs.  The URL is not checked to ensure that it is valid.  If ErrorUrl is not supplied or is empty, default processing occurs (user is redirected to an error page with details about the error).

If non-empty, two additional request parameters are added to the URL to help identify the Firmwater LMS session that experienced the error:

• session_id: Number that uniquely identifies the Firmwater LMS session that experienced the error.
• error_datetime: String in universal sortable date/time pattern that identifies when the error occurred.
  

TimeoutMinutes

An integer indicating the number of minutes of inactivity before which the user's session should timeout.  If not specified or 0, the system's default timeout is used.

CloseWindowOnExit

A boolean value indicating whether the user's browser window should close on exit from Firmwater LMS.  The browser window can only be closed if it was opened by script.  If CloseWindowOnExit is set to true and the window was not opened by script, a page indicating that the session has ended is displayed on logout, even if ReturnUrl is specified.