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 / userProfileGet

  • Article
  • 1 minutes to read

Description

Invoke this method to get user profile data

API Details

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

Request Parameters

The userProfileGet 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
userId accountIdType Optional User ID for whom you want to get profile data, if not specified it returns your own profile data. If your session is a basic user, you can only get your own profile

Response Parameters

Name Type Attributes Description
profileData userProfileData Required The user profile data.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document