Get Unstructured Document Access Rights - Fluid Topics - 3.4 - Reference Guides

Fluid Topics API Reference Guide

Product
Fluid Topics
FT_Version
3.4
Category
Reference Guides
language
English
audience
public

This web service is used to get information about who (users and groups) can access a document identified by its docId. Three access rights levels exist:

  • PUBLIC: The document is accessible to all users, whether they are authenticated or anonymous.
  • AUTHENTICATED: The document is accessible only to authenticated users, whatever groups they belong to.
  • RESTRICTED: The document is accessible only to users from specific groups.

Dataflow web services are only available to users with the KHUB Administrator Role. Basic authentication via the header is required.

Method

Endpoint

GET

/api/khub/documents/$DOC_ID/rights

Where:

  • $DOC_ID is the document identifier. It has to be double URL encoded.

Output Examples

{
"accessLevel": "PUBLIC"
}

{
"accessLevel": "AUTHENTICATED"
}

{
"accessLevel": "RESTRICTED",
"groups": [
"internal",
"partners"
]
}