Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

/ session / guestLogon

  • Article
  • 1 minutes to read

Description

Invoke this operation to log in as a guest to the system. In order to invoke this you must have previously made a call to ‘session::guestGetSessionInfo’. This operation will verify you as a valid contact on the system. If you are authorized to log in then your session will be promoted to an ‘authenticated’ visitor. If you are already logged in as a full user, this operation will fail.

API Details

  • Status:
  • The required privilege level to invoke this method is guest
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The guestLogon method takes the following input parameters. It is important to note that the parameters must be passed to the method in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
loginId xs:string Required Can be any valid login ID for your account. The login Id is typically your system-defined unique identifier or your e-mail address.
password passwordType Required The password for this account.

Response Parameters

Name Type Attributes Description
verificationToken xs:string Optional If this is set, the login was successful but requires a secondary verification, see ‘guestLogonVerify’ for more details.
verificationCode xs:unsignedInt Optional The authentication code sent. This property is never provided on production systems, it’s only used for testing
userVerifyExpires xs:dateTime Optional The date/time the user verification code expires.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document