Documentation

This is taking longer than usual. If nothing appears, refresh the page.

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}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

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

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

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

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ session / guestGetSessionInfo

  • Article
  • 2 minutes to read

Description

Invoke this operation to obtain session information relating to a guest account associated with an application. Guest login’s are used by web applications that require some interaction with the core application logic. This operation allows a web application to establish a working context based on the security model that is defined when creating the web application instance. If a session is already established the operation will return information about the application session. If there is no session, then an anonymous session will be established and information about that will be returned to the caller. 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 none
  • The supported database role for this method is none
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The guestGetSessionInfo 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
portalId accountIdType Required The portal ID for which you wants to get session information for.
returnPortalOptions xs:boolean Optional
Default=false		 Set this to true if you want to retrieve portal options. Default is false as this adds a performance hit so should only be used sparingly.

Response Parameters

Name Type Attributes Description
sessionId xs:string Required The newly created session identifier. This is a string value that uniquely identifies the session you have just created
guestRole guestRoleType Required Returns either ‘anonymous’ or ‘authenticated’.
ssoProfile xs:string Optional The name of a guest single-sign-on profile to use for guest access.
allowSelfServicePasswordReset xs:boolean Optional Returns ‘true’ if password resets are allowed on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
allowGuestSelfRegistration xs:boolean Optional Returns ‘true’ if guest self-registrations allowed on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
needGuestSelfRegistrationAuthorization xs:boolean Optional Returns ‘true’ if guest registration authorisation is required on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
allowGuestSelfRegistrationOrgSetting xs:boolean Optional Returns ‘true’ if contacts can choose their organization when registering themselves on this portal. The ‘returnPortalOptions’ input parameter must be set to ‘true’ in order for this value to be returned.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document