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
  • 2 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.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

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
twofaMethod twofaMethodType Optional If using two-factor authentication, this tells us what 2FA type is being used
guestVerifyExpires xs:dateTime Optional The date/time the user verification code expires.
verificationToken xs:string Optional If this is set, the login was successful but requires a secondary verification, see ‘guestLogonVerify’ for more details.
verificationCode xs:string Optional The two-factor authentication code sent to the user for verification. This param is never provided on production systems, it’s only used for testing.
registrationRequired xs:boolean Optional
Default=false		 If TOTP Authentication has been mandated for this account but no Authenticator app has been registered for this account, then this is set to ‘true’ and the user should be presented with the option to register their Authenticator app
registrationTotpSecret xs:string Optional If TOTP Authentication has been mandated for this account but no Authenticator app has been registered for this account, assuming the user credentials are correct, this will be set to the TOTP secret key that should be used to register the Authenticator app.
registrationTotpQrCode xs:string Optional If the TOTP has been mandated for this account but no Authenticator app has been registered for this account, assuming the user credentials are correct, this will be set to the QR code that should be rendered to the user so they can register the Authenticator app to their account.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document