Роли и разрешения

Обзор

Роль — это набор разрешений: какие объекты приложение может читать или изменять, какие поля оно может видеть и какие возможности платформенного уровня оно может использовать. Функции логики и фронтенд‑компоненты каждого приложения наследуют разрешения роли, помеченной с помощью defineApplicationRole() (см. раздел Роль функции по умолчанию ниже).

src/roles/restricted-company-role.ts

import {
  defineRole,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
  SystemPermissionFlag,
} from 'twenty-sdk/define';

export default defineRole({
  universalIdentifier: '2c80f640-2083-4803-bb49-003e38279de6',
  label: 'My new role',
  description: 'A role that can be used in your workspace',
  canReadAllObjectRecords: false,
  canUpdateAllObjectRecords: false,
  canSoftDeleteAllObjectRecords: false,
  canDestroyAllObjectRecords: false,
  canUpdateAllSettings: false,
  canAccessAllAgentChatChannels: false,
  canBeAssignedToAgents: false,
  canBeAssignedToUsers: false,
  canBeAssignedToApiKeys: false,
  objectPermissions: [
    {
      objectUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier,
      canReadObjectRecords: true,
      canUpdateObjectRecords: true,
      canSoftDeleteObjectRecords: false,
      canDestroyObjectRecords: false,
    },
  ],
  fieldPermissions: [
    {
      objectUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier,
      fieldUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.fields.name
          .universalIdentifier,
      canReadFieldValue: false,
      canUpdateFieldValue: false,
    },
  ],
  permissionFlagUniversalIdentifiers: [SystemPermissionFlag.WORKSPACE_APPS],
});

SystemPermissionFlag.USER_APPS и SystemPermissionFlag.WORKSPACE_APPS доступны в twenty-sdk начиная с версии 2.54; в более ранних версиях они называются CONNECTED_ACCOUNTS и APPLICATIONS. Старые имена являются устаревшими псевдонимами для тех же флагов, и роль содержит каждый флаг только один раз. Перечисление SystemPermissionFlag, например с помощью Object.keys, по-прежнему включает старые имена. API также сообщает об этих флагах под их старыми ключами, например в currentUserWorkspace.permissionFlags.

Безопасность на уровне строк

Для разрешений на уровне строк требуется план Organization или выше — см. тарифы. Что происходит при использовании плана без соответствующего права, описано в примечаниях в конце этого раздела. Разрешения на объекты и поля определяют, к каким объектам и полям у роли есть доступ. Предикаты прав доступа на уровне строк заходят дальше и определяют, какие записи роль может видеть и с которыми может работать — например, для роли самообслуживания, где каждый внешний пользователь видит только свои собственные записи. Объявляйте предикаты с помощью rowLevelPermissionPredicates в роли. Как и остальная часть манифеста, каждый предикат имеет свой собственный universalIdentifier и ссылается на объект и поле по их universalIdentifier, operand, а также (необязательно) поле workspaceMember, значение которого подставляется во время выполнения запроса — чтобы вы могли выразить: “отношение владельца записи является текущим участником рабочей области”:

src/roles/partner-role.ts

import {
  defineRole,
  RowLevelPermissionPredicateOperand,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';

import { ACCOUNT_OWNER_FIELD_UNIVERSAL_IDENTIFIER } from '../fields/account-owner.field';

export default defineRole({
  universalIdentifier: 'c3c1dc2e-1a08-4de5-abb7-2139b3d99343',
  label: 'Partner',
  description: 'External partner — sees only its own records',
  canBeAssignedToUsers: true,
  objectPermissions: [
    {
      objectUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier,
      canReadObjectRecords: true,
      canUpdateObjectRecords: true,
    },
  ],
  rowLevelPermissionPredicates: [
    {
      universalIdentifier: 'd0f0c1a2-3b4c-4d5e-8f60-111111111111',
      objectUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier,
      fieldUniversalIdentifier: ACCOUNT_OWNER_FIELD_UNIVERSAL_IDENTIFIER,
      operand: RowLevelPermissionPredicateOperand.IS,
      workspaceMemberFieldUniversalIdentifier:
        STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.workspaceMember.fields.id
          .universalIdentifier,
    },
  ],
});

Поскольку предикаты поставляются в манифесте, они создаются, обновляются и удаляются вместе с ролью при каждой установке и обновлении — не требуется отдельный шаг после установки для поддержания синхронизации.

Комбинирование предикатов с группами

По умолчанию предикаты роли комбинируются с помощью AND. Чтобы комбинировать некоторые из них с помощью OR (или вкладывать логику), объявите запись rowLevelPermissionPredicateGroups и укажите на неё каждый предикат через predicateGroupUniversalIdentifier. Эта роль позволяет партнёру видеть сделку, которая либо принадлежит ему, либо по которой он является контактным лицом:

src/roles/partner-opportunities-role.ts

import {
  defineRole,
  RowLevelPermissionPredicateGroupLogicalOperator,
  RowLevelPermissionPredicateOperand,
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS,
} from 'twenty-sdk/define';

const OPPORTUNITY = STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.opportunity;
const CURRENT_MEMBER =
  STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.workspaceMember.fields.id
    .universalIdentifier;

export default defineRole({
  universalIdentifier: 'b2a1c0d9-8e7f-4a6b-9c5d-222222222222',
  label: 'Partner (opportunities)',
  canBeAssignedToUsers: true,
  objectPermissions: [
    {
      objectUniversalIdentifier: OPPORTUNITY.universalIdentifier,
      canReadObjectRecords: true,
    },
  ],
  rowLevelPermissionPredicateGroups: [
    {
      universalIdentifier: 'c3b2a1d0-9f8e-4b7a-8d6c-333333333333',
      objectUniversalIdentifier: OPPORTUNITY.universalIdentifier,
      logicalOperator: RowLevelPermissionPredicateGroupLogicalOperator.OR,
    },
  ],
  rowLevelPermissionPredicates: [
    {
      universalIdentifier: 'd4c3b2a1-0e9f-4c8b-9e7d-444444444444',
      objectUniversalIdentifier: OPPORTUNITY.universalIdentifier,
      fieldUniversalIdentifier: OPPORTUNITY.fields.owner.universalIdentifier,
      operand: RowLevelPermissionPredicateOperand.IS,
      workspaceMemberFieldUniversalIdentifier: CURRENT_MEMBER,
      predicateGroupUniversalIdentifier: 'c3b2a1d0-9f8e-4b7a-8d6c-333333333333',
    },
    {
      universalIdentifier: 'e5d4c3b2-1f0e-4d9c-8f8e-555555555555',
      objectUniversalIdentifier: OPPORTUNITY.universalIdentifier,
      fieldUniversalIdentifier:
        OPPORTUNITY.fields.pointOfContact.universalIdentifier,
      operand: RowLevelPermissionPredicateOperand.IS,
      workspaceMemberFieldUniversalIdentifier: CURRENT_MEMBER,
      predicateGroupUniversalIdentifier: 'c3b2a1d0-9f8e-4b7a-8d6c-333333333333',
    },
  ],
});

Заметки:

Присвойте каждому предикату и группе стабильный universalIdentifier (любой uuid) — он служит ключом сущности между обновлениями, а предикаты ссылаются на группы по нему.
Предикаты могут ссылаться на объекты и поля, принадлежащие вашему приложению, или на стандартные объекты и поля Twenty.
Безопасность на уровне строк применяется к рабочим пространствам на плане Organization или выше. В других планах предикаты, объявленные в манифесте приложения, по-прежнему синхронизируются, но не применяются.
API метаданных здесь ведёт себя иначе, чем манифест: без соответствующего права upsertRowLevelPermissionPredicates отклоняется с ошибкой ROW_LEVEL_PERMISSION_FEATURE_DISABLED вместо синхронизации. Следовательно, рабочее пространство на плане, который не включает безопасность на уровне строк, не может создавать предикаты вне манифеста приложения, даже несмотря на то, что поле rowLevelPermissionPredicates присутствует в типе Role при интроспекции схемы.

Роль функции по умолчанию

Когда вы создаёте новое приложение с помощью шаблона, CLI создаёт файл роли по умолчанию, объявленный с помощью defineApplicationRole():

src/roles/default-role.ts

import { defineApplicationRole } from 'twenty-sdk/define';

export const DEFAULT_ROLE_UNIVERSAL_IDENTIFIER =
  'b648f87b-1d26-4961-b974-0908fd991061';

export default defineApplicationRole({
  universalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
  label: 'Default function role',
  description: 'Default role for function Twenty client',
  canReadAllObjectRecords: true,
  canUpdateAllObjectRecords: false,
  canSoftDeleteAllObjectRecords: false,
  canDestroyAllObjectRecords: false,
  canUpdateAllSettings: false,
  canBeAssignedToAgents: false,
  canBeAssignedToUsers: false,
  canBeAssignedToApiKeys: false,
  objectPermissions: [],
  fieldPermissions: [],
  permissionFlagUniversalIdentifiers: [],
});

defineApplicationRole() — это тонкая обёртка вокруг defineRole(), которая помечает ту роль, которая используется как роль приложения по умолчанию во время установки. Проверка идентична defineRole, но конвейер сборки автоматически подключает его universalIdentifier к полю defaultRoleUniversalIdentifier манифеста приложения — поэтому вам не нужно ссылаться на него из defineApplication самостоятельно. Заметки:

Допускается ровно один вызов defineApplicationRole(...) на приложение — сборка манифеста завершится с ошибкой, если будет найдено более одного.
Используйте defineRole() (а не defineApplicationRole()) для любых дополнительных ролей, которые ставятся вместе с вашим приложением.
Явная установка defaultRoleUniversalIdentifier в defineApplication() всё ещё поддерживается для обратной совместимости, но считается устаревшей по сравнению с defineApplicationRole(). Он также может указывать роль, которую ваше приложение не определяет, например встроенную роль по умолчанию пользовательского приложения рабочего пространства, сохраняемую командой twenty app pull; в таком случае сборка не может проверить эту роль, поэтому она должна существовать в целевом рабочем пространстве.
Роль, которую можно назначать участникам рабочего пространства или ключам API (canBeAssignedToUsers или canBeAssignedToApiKeys, оба значения true, если они не указаны), является пользовательской ролью и требует план Organization или выше: на других планах установка отклоняется. Оставьте оба значения false для ролей, от имени которых работают только ваше приложение и его агенты.

Роли агентов

Роль приложения — это то, что рабочее пространство проверяет при установке вашего приложения, поэтому она должна охватывать всё, что может делать само приложение. Любая роль, которую вы назначаете агенту через roleUniversalIdentifier в defineAgent(), не должна предоставлять больше прав, чем роль приложения: никаких действий с объектами, доступа к полям, флагов разрешений или областей действия на уровне строк, которых нет у роли приложения. Если это не так, сборка завершается с ошибкой, в которой перечислены избыточные предоставленные права. Роли, которые ваше приложение предоставляет для участников рабочего пространства или ключей API, не подпадают под это правило, поскольку приложение никогда не запускается с ними. Для проверки необходима роль приложения в исходном коде вашего приложения, поэтому она пропускается, когда роль по умолчанию определена в другом месте.

Лучшие практики

Начните с сгенерированной роли и постепенно ограничивайте её — роль по умолчанию предоставляет широкий доступ на чтение, что редко подходит для продакшена.
Замените objectPermissions и fieldPermissions на точные объекты и поля, которые действительно нужны вашим функциям.
permissionFlagUniversalIdentifiers управляют доступом к возможностям на уровне платформы. Сведите их к минимуму.
Флаг разрешения, объявляемый вашим приложением с помощью definePermissionFlag(), имеет permissionType: 'tool' (по умолчанию) для возможности, которая может быть предоставлена агенту или пользователю, и 'settings' для флага, открывающего область настроек.
Смотрите рабочий пример: examples/hello-world/src/roles/default-role.ts.

Разработчики

Приложения

API

Самостоятельный хостинг

Внести вклад

Библиотека интерфейса

Обзор

Безопасность на уровне строк

Комбинирование предикатов с группами

Роль функции по умолчанию

Роли агентов

Лучшие практики

​Обзор

​Безопасность на уровне строк

​Комбинирование предикатов с группами

​Роль функции по умолчанию

​Роли агентов

​Лучшие практики

Обзор

Безопасность на уровне строк

Комбинирование предикатов с группами

Роль функции по умолчанию

Роли агентов

Лучшие практики