Skip to main content

Users Management - Permissions Metadata Read

Endpoint​

/o/users/permissions

Overview​

Returns feature permission dependency metadata used when building permission matrices.

Authentication​

  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions​

  • Requires core read permission for the selected app scope.

Request Parameters​

ParameterTypeRequiredDescription
api_keyStringYes (or use auth_token)Dashboard API key.
auth_tokenStringYes (or use api_key)Dashboard auth token.
app_idStringYes for non-global-admin usersApp id used by read-permission validation.

Response​

Success Response​

{
  "features": [
    "core",
    "events"
  ],
  "featuresPermissionDependency": {
    "data_manager": {
      "u": {
        "data_manager": ["r", "u"]
      }
    }
  }
}

Response Fields​

FieldTypeDescription
featuresArray of StringBase feature list used in dependency calculation.
featuresPermissionDependencyObjectDependency graph populated by installed modules.
featuresPermissionDependency.featureKey.crudKey.dependencyFeatureKeyArray of StringRequired CRUD permissions for dependency feature.

Error Responses​

Authentication and authorization failures are returned by the common auth layer.

Behavior/Processing​

Behavior Modes​

ModeTriggerResponse Shape
Dependency graph returnedPermissions check passesObject containing features and featuresPermissionDependency.

Database Collections​

This endpoint does not directly read or write database collections.

Examples​

Example 1: Read permission dependency metadata​

/o/users/permissions?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2

Limitations​

  • Output is metadata for permission dependency, not a per-user effective-permissions result.
  • Content depends on installed modules that contribute dependency rules.

Last Updated​

2026-02-17