Access control model

Important

Lakewatch is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage workspace-level previews.

Lakewatch access control is governed by Unity Catalog. Lakewatch resources are Unity Catalog securables that live in a catalog and schema you choose, and you grant access to them using Unity Catalog privileges. Access is inherited down the Unity Catalog hierarchy, so a grant on a catalog or schema applies to the Lakewatch resources beneath it.

Principals

Access is granted to principals: individual users, service principals (identified by name or applicationId), and groups. Lakewatch doesn't require particular groups, so you can grant access to any identity that Unity Catalog supports. For a recommended team-based setup that maps groups to security roles, see Set up access control.

Lakewatch resources as Unity Catalog securables

These Lakewatch resources are Unity Catalog securables and live under a catalog and schema that you choose:

  • Datasources
  • Detection rules

You organize them like any other Unity Catalog data, for example a catalog per environment (dev/staging/prod) and a schema per team. See Deployment models for suggested patterns.

Two groups of resources are governed by Unity Catalog but handled differently:

  • Queries are managed through the Lakewatch app, using their own permission levels rather than the privileges you grant on datasources and detection rules.
  • Signals and alerts are derived from their parent resource: a detection rule produces signals, which are collated into alerts, and a datasource can raise system errors, which Lakewatch also records as alerts. They aren't separate securables, so you don't grant on them directly. The security-data privileges (READ_SECURITY_DATA and UPDATE_SECURITY_DATA) on the parent detection rule or datasource control access to them.

Environments and folders

Lakewatch registers the Unity Catalog catalogs and schemas that hold your resources as environments and folders:

  • An environment is a catalog registered with Lakewatch (the top-level scope for its resources). An environment is available only from the workspace its catalog is bound to (see Workspace-catalog binding).
  • A folder is a schema registered with Lakewatch under that catalog. Datasources and detection rules live in folders, and the privileges you grant on a folder apply to every resource it contains.

Environments and folders are a view over the catalog-per-environment, schema-per-team organization described in Deployment models. They don't change how access is granted. Folder permissions are Unity Catalog grants on the backing schema, so the privileges and inheritance described on this page apply unchanged.

Privileges

You grant access with Unity Catalog privileges on a catalog or schema, which Lakewatch shows as an environment or folder. Lakewatch defines privileges for reading a resource's configuration, managing the resource, and managing its access. Detection rules also have privileges for reading or updating the security data (signals and alerts) they produce. For the complete list per resource type and what each privilege allows, see Roles and capabilities.

To create a resource, a principal must have USE CATALOG on the catalog and USE SCHEMA on the schema. It must also have the create privilege on that schema or catalog: CREATE_DATASOURCE for a datasource or CREATE_RULE for a detection rule. USE CATALOG and USE SCHEMA are traversal privileges: on their own they allow a principal to reach the catalog and schema but don't grant the ability to view a resource (that requires READ_METADATA) or to create one. Lakewatch grants both to all account users (see Permission groups), so you grant only the privilege for the action, usually through a permission group.

Inheritance

Access flows down the Unity Catalog hierarchy: catalog, then schema, then resource. A privilege granted on a catalog or schema applies to every Lakewatch resource beneath it, so you grant access at the catalog or schema level instead of on each resource.

The recommended setup grants administrators their privileges on the catalog, so they apply to every folder and resource in the environment, and grants every other group its privileges on a folder, so they apply only to the resources in that folder.

Signals and alerts are derived artifacts with no grants of their own. Access is inherited from the parent detection rule or datasource, but through a privilege that's separate from reading the parent's configuration:

  • READ_METADATA on a detection rule enables you to read the rule and its configuration. It doesn't, by itself, grant access to the signals and alerts the rule produces.
  • Viewing those signals and alerts requires READ_SECURITY_DATA on the parent rule or datasource (a separate privilege from READ_METADATA).
  • Updating an alert follows the UPDATE_SECURITY_DATA privilege on the parent rule or datasource. Signals are immutable.

Ownership

The principal who creates a Lakewatch resource becomes its owner, with full control of the resource including managing its access. Ownership can be transferred. To share a resource with others, grant them privileges on its folder.

Settings

Lakewatch settings are bound to a catalog and apply to all Lakewatch resources under it. A principal with MANAGE on the catalog can change that catalog's settings.

Onboarding and administration

Before anyone can use Lakewatch in a workspace, someone must set it up, which creates the first environment and its folders and grants initial access. With the Recommended configuration, all account users get Lakewatch admin on the environment and every Lakewatch permission on both default folders. With Custom configuration, you select who gets access from the start.

A user who has the relevant create privilege on a folder (CREATE_DATASOURCE or CREATE_RULE, included in Datasource manager, Detection rule manager, Folder admin, and Lakewatch admin) can create Lakewatch resources in that folder and owns what they create. To restrict access for a team, follow Set up access control. To delegate management of a set of resources, grant Lakewatch admin on the environment or Folder admin on a folder.

Lakewatch admin isn't a separate role or override. It's a permission group of Unity Catalog privileges granted on the environment's catalog. Lakewatch admin and workspace administrator are independent: a workspace administrator who isn't a Lakewatch admin has no additional access to Lakewatch resources, and a Lakewatch admin doesn't need to be a workspace administrator.

Access control is primarily owner-based: a privilege check is satisfied by an explicit grant or by owning the resource. Account administrators and metastore administrators can take ownership or grant themselves MANAGE through Unity Catalog admin privileges. If a resource's owner is lost (for example, the person leaves or a service principal is deleted) and no other principal holds MANAGE, access can be hard to recover, so Databricks recommends owning production resources with a group. See Deployment models.

Scheduled jobs and the run-as principal

Each datasource and detection rule records a run-as principal. You select it when you create the resource (your own identity, or a service principal you have permission to use), and only someone with MANAGE on the resource can change it. The scheduled ingestion and detection pipelines for the resource run as this principal, so it must be granted access to the tables that the datasource or detection rule references. To create a service principal for this purpose and grant it the access its scheduled jobs need, see Set up access control.

Audit logs

Lakewatch logs requests to its resources as workspace-level audit events under the lakewatch service. Permission changes on environments and folders are Unity Catalog grants, so they're logged at the account level as Unity Catalog updatePermissions events under the unityCatalog service instead. See Lakewatch events.