This public web service allows to get information about the current session.
Method | Endpoint |
---|---|
GET |
|
Response body
{
"sessionAuthenticated": true,
"profile": {
"userId": "9e193047-860c-418b-8941-bfd59ca5b2a6",
"displayName": "John Arthur Doe",
"emailAddress": "jdoe@fluidtopics.com",
"roles": [
"KHUB_ADMIN",
"PERSONAL_BOOK_USER",
"DEBUG_USER",
"PERSONAL_BOOK_SHARE_USER",
"ADMIN",
"PDF_EXPORT_USER",
"BETA_USER",
"PORTAL_ADMIN",
"SAVED_SEARCH_USER",
"USERS_ADMIN",
"HTML_EXPORT_USER"
]
},
"tags": [
"tag1",
"tag2"
],
"authenticationIdentifier": {
"identifier": "jdoe@fluidtopics.com",
"realm": "Root User"
},
"idleTimeoutInMillis": -1,
"searchPreferences": {
"defaultFilters": [
{
"key": "audience",
"values": [
"\"premium\""
],
"negative": false
}
],
"defaultMetadataFilters": [
{
"key": "audience",
"valueFilter": {
"values": [
"premium"
],
"negative": false
}
}
]
}
}
Field | Type | Description |
---|---|---|
sessionAuthenticated |
Boolean | The authentication status of the user. |
profile |
Object | An object containing information about the user. |
userId |
String | Optional. Only present when sessionAuthenticated is true . The identifier of the connected user. |
displayName |
String | Optional. Only present when sessionAuthenticated is true . The display name of the user. |
emailAddress |
String | Optional. Only present when sessionAuthenticated is true . The email address of the user. |
roles |
Array | Indicates the roles of the user. |
authenticationIdentifier |
Object | Optional. Only present when sessionAuthenticated is true . Information about the authentication of the user. |
identifier |
String | The user identifier in the realm. |
realm |
String | Indicates the realm to which the user belongs. |
idleTimeoutInMillis |
Number | The authentication timeout set in the portal, expressed in milliseconds. For example, for the default timeout value of 30 minutes, the idleTimeoutInMillis value is 1800000 . When there is no timeout, the value is -1 . |
searchPreferences |
Object | The search preferences of the user, as set in the My Account menu. |
defaultFilters |
Array | The search filters of the user, as set in the My Account menu. |
defaultMetadataFilters |
Array | Filters the results based on selected criteria including metadata and date ranges. Defaults to an empty list. |
key |
String | Expects a metadata key. |
valueFilter |
Object | Contains the filtering conditions based on metadata values. |
values |
Array | Defines the value for the selected key. When multiple values are defined, they are combined with an AND or an OR operator depending on the tenant's configuration. |
negative |
Boolean | When true , this parameter excludes results matching the previously defined values. By default, the negative parameter is implicit and false . |
dateFilter |
Object | Specifies the date-based filtering conditions using predefined periods. |
type |
String | Restricts results to those within a predefined period. Acceptable values are LAST_WEEK , LAST_MONTH , LAST_QUARTER , LAST_YEAR . |
rangeFilter |
Object | Specifies custom date range filtering. |
from |
String | The inclusive start date of the period. If unspecified, the default value is 1970-01-01 . |
to |
String | The inclusive end date of the period. If unspecified, the default value is the current day. |
The defaultFilters
array is deprecated. Use the defaultMetadataFilters
array instead. It combines the values of both arrays.