Skip to content

Permissions overview

Codatum has role-based permission management. Every user always has exactly one workspace role. Resources such as connections and teamspaces can also have resource roles, and notebooks and reports can have sharing settings. Whether an operation is allowed is determined by a combination of these.

Terminology

Terms used to describe permissions. For more detailed definitions, such as the relationship between accounts and users, also see Account and the Glossary.

TermMeaning
UserAn account that belongs to a workspace
GroupA collection of users that can be granted permissions together. A single group can be assigned multiple resource roles
ResourceAn object such as a notebook, connection, or teamspace
OperationAn action such as inviting a user or editing a notebook
Workspace roleA role assigned to a user within a workspace
Resource roleA role tied to an individual resource, assigned to a group or an individual user
PermissionThe ability to perform a specific operation, determined by a combination of roles

Evaluation rules

No Yes No Yes Yes No Can theoperationrun? Does theworkspaceroleallow it? Deny Tied to aresource? Allow Does theresourceroleallow it?
  1. Roles have a hierarchy. A lower role's access is also carried by higher roles (Role hierarchy).
  2. Operations tied to a resource are evaluated with AND. They're allowed only when both the workspace role and the resource role allow them.
  3. Multiple roles on the same resource are evaluated with OR. If any one of them allows the operation, whether granted directly or through a group, it's allowed.
  4. Operations tied only to the workspace are determined by the workspace role alone. For example, inviting users.

For operations determined by the workspace role alone, see Workspace permissions.

Role hierarchy

"X or higher" in the tables means that role and any higher role can perform the operation.

TypeFrom highest to lowest
Workspace roleWorkspace Owner, Workspace Editor, Workspace Viewer, Workspace Guest
Connection resource roleConnection Owner, Connection User, Connection Viewer
Teamspace resource roleTeamspace Owner / Teamspace Editor / Teamspace Viewer (Owner and Editor/Viewer aren't mutually exclusive. For details, see Teamspace permissions)

Main topics

Control methods

How permissions are determined varies by resource.

MethodTargetWhat determines it
Resource roleGroupGroup Owner (resource role)
Resource roleConnectionAccess level and the granted resource role
Resource roleTeamspaceThe granted resource role
Resource sharing settingsNotebook / ReportThe access scope of the root folder, and additional notebook permissions or report sharing settings
Owner assignmentWorkflowThe owners (users or groups) assigned to each workflow. Creation and managing all workflows are governed by the workspace role
DerivedSaved query / CatalogThe permissions of the linked connection. There's no dedicated resource role
Follows the executing user's permissionsAI agentNo dedicated resource role. Additional restrictions come from the AI profile's tool permissions

Access scope

For some resources, such as notebooks, the type of root folder they belong to becomes the access scope, which determines how permissions are evaluated. For the conditions for each operation, see Notebook access scope.

ScopeKey points
WorkspaceWorkspace members can access it according to their workspace role
TeamspaceAccess is determined by the teamspace resource role
PrivateUnder the "Private" root folder. Only the owner, if they're a Workspace Editor or higher, can operate on it
SharedUsers and groups granted permissions through additional notebook permissions can access it. It appears in the Shared folder on the recipient's side

Relationship with credentials

CredentialHow permissions apply
Browser login
(account)
Evaluated by the workspace role / resource role of the user in their workspace
PATCapped by the issuing account's user permissions, and further narrowed by the permission boundary (connections / notebooks / tags) specified at issuance. See Personal Access Tokens for issuance, and Personal Access Tokens for managing them within a workspace
API keyTied to the workspace. Only usable for granted signed embeds. See API keys for details