Get a publication's access rights - Fluid Topics - Latest

Fluid Topics API Reference Guide
Category
Reference Guides
Audience
public
Version
Latest

This web service returns information about who (users and groups) can access a publication based on its access rules.

Method Endpoint
GET 
/api/khub/documents/{publicationId}/rights
Path parameter Type Description
{publicationId} String The document's identifier. Users can get the id by using the Clustered search web service.

It is necessary to provide an Ft-Calling-App value when using Fluid Topics web services. See Fluid Topics calling app.

Response bodies

The following example shows a JSON response body for this web service:

{
  "accessLevel": "RESTRICTED",
  "groups": [
    "internal"
  ],
  "condition": {
    "operator": "OR",
    "operands": [],
    "groups": [
      "internal"
    ]
  }
}

In this example, the publication is only accessible by users from the internal group.

Field Type Description
accessLevel String The access rights level that has been configured for the targeted publication. Can be:
  • PUBLIC: The document is accessible to all users, whether authenticated or unauthenticated.
  • AUTHENTICATED: The document is accessible to authenticated users only, regardless of which groups they belong to.
  • RESTRICTED: The document is accessible only to users from specific groups.
groups Array For RESTRICTED access: the user groups who are allowed to access the document.
condition Object Appears for RESTRICTED access levels. An object to indicate for whom the publication is accessible.
operator String Can be OR or AND. AND appears to indicate multiple values.
operands Array Contains nested conditions (each with their own operator, groups, and operands fields).
groups Array A user group name for which the access rule applies.