Get User Information and Resources - Fluid Topics - 3.6

Use Fluid Topics Web API

Product
Fluid Topics
FT_Version
3.6
Category
Technical Notes
language
English

This web service returns all the user information and resources.

It dumps user-related information such as display name, credentials, etc., as well as the user's resources such as Scopes, Personal Books, and so on.

Method

Endpoint

GET

/api/users/$USER_ID/dump

Where

  • $USER_ID is the user identifier. The $USER_ID is unique and can be retrieved from the List All Users web service.

The output contains all the user-related information:

  • User metadata
  • Credentials (login and hashed password)
  • Bookmarks
  • Scopes
  • Saved Searches (a.k.a Alerts)
  • Personal Books
  • Personal Topics

User's information dump is only available to ADMIN users.

Output Example

{
{
"user": {
"id": "93fc96ca-6e95-4e60-8c58-1f475336049b",
"displayName": "User",
"emailAddress": "user@fluidtopics.com",
"creationDate": "2018-08-06T14:19:14.199+0000",
"lastLoginDate": "2018-08-06T14:19:58.247+0000",
"manualGroups": [],
"authenticationGroups": [],
"manualRoles": [
"BETA_USER",
"PERSONAL_BOOK_USER",
"HTML_EXPORT_USER",
"PDF_EXPORT_USER",
"SAVED_SEARCH_USER",
"PERSONAL_BOOK_SHARE_USER",
"DEBUG_USER"
],
"authenticationRoles": [],
"defaultRoles": [],
"authenticationIdentifiers": [
{
"identifier": "user@fluidtopics.com",
"realm": "internal"
}
],
"userLocale": {
"uiLocale": "en-US",
"searchContentLocale": "en-US"
},
"active": true
},
"credentials": {
"login": "user@fluidtopics.com",
"password": "9H3JUBlpB3AvANOeARD3UnV9eJEOo+xFPNoUhugSlsM="
},
"bookmarks": [
{
"id": "9c752ba7-69f2-4d12-be68-d3f58bf1306a",
"title": "Fluid Topics Tenant Setup",
"creationDate": "2018-08-06T14:20:17.691+0000",
"colorCssClass": "color-3",
"origin": {
"mapId": "a7wNxXBLbM65nqkOxv14ug",
"mapTitle": "Fluid Topics v2 - Installation and Integration Guide",
"tocId": "YSMVQCP7eLR8sEVEifkydQ",
"breadcrumb": [
"Fluid Topics Tenant Setup"
]
}
}
],
"searchScopes": [
{
"id": "4d9db96e-08e2-42f8-ba5a-c3d25b4cbb06",
"title": "my scope",
"documentTypeFilter": "ALL",
"filters": [
{
"key": "FILTERING_TEST",
"values": [
"\"FILTERING_TEST: mails\""
],
"negative": false
}
]
}
],
"savedSearches": [
{
"id": "9a1ee243-9c2d-4a20-9694-4c83e20af3b8",
"name": "this is my saved search",
"description": "",
"request": {
"query": "this is my saved search",
"scope": "ALL",
"filters": [],
"sorts": [
{
"name": "afs:relevance",
"order": "DESC"
},
{
"name": "ft:isPublication",
"order": "DESC"
},
{
"name": "ft:isArticle",
"order": "ASC"
},
{
"name": "ft:topicTitle",
"order": "ASC"
},
{
"name": "ft:publication_title",
"order": "ASC"
},
{
"name": "ft:lastEdition",
"order": "DESC"
}
],
"contentLocale": "en-US",
"tracked": true
},
"schedule": {
"scheduled": true
},
"creationDate": "2018-08-06T14:21:08.534+0000",
"lastUpdateDate": "2018-08-06T14:21:08.534+0000"
}
],
"personalBooks": [
{
"id": "0960605a-ea84-434d-8431-cd422ee940f8",
"title": "My book ",
"tagline": "comment",
"creationDate": "2018-08-06T14:20:24.975+0000",
"lastUpdateDate": "2018-08-06T14:20:54.120+0000",
"topicsCount": 2
}
],
"personalTopics": [
{
"id": "a63fdc8c-5e1e-4ced-b5c2-45862ff747d9",
"title": "My personal topic",
"text": "<p>Hi, this is my personal topic</p>\n<p> </p>",
"creationDate": "2018-08-06T14:20:53.988+0000",
"lastUpdateDate": "2018-08-06T14:20:53.988+0000"
}
]
}
}