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

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

This web service returns information about which of the following access rights levels have been configured for a targeted map:

  • PUBLIC: The map is accessible to all users, whether authenticated or unauthenticated.
  • AUTHENTICATED: The map is accessible to authenticated users only, regardless of which groups they belong to.
  • RESTRICTED: The map is accessible only to users from specific groups.
Method Endpoint
GET 
/api/khub/maps/{mapId}/rights
Path parameter Type Description
{mapId} String Expects the id associated with the map. Users can get the id by listing maps or searching maps.

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

Response body

The following lines show an example of a JSON response body:

{
  "accessLevel": "RESTRICTED",
  "groups": [
    "internal",
    "partners"
  ]
}
Field Type Description
accessLevel String The access rights level that has been configured for the targeted map.