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 who (users and groups) can access a map based on its access rules.

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 example shows a JSON response body for this web service:

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

In this example, the map 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 map. Can be:
  • 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.
groups Array For RESTRICTED access: the user groups who are allowed to access the map.
condition Object Appears for RESTRICTED access levels. An object to indicate for whom the map 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.