NOnocodb
Permissions

Set permission

Changed on

Create or replace the grant for one permission on a table or field. A grant is exactly one rule: a minimum role (granted_type role with granted_role), named users and teams (granted_type user with subjects), or nobody. TABLE_VISIBILITY can be set by base owners only.

Note: Table and field permissions are available on cloud-hosted Business plans and above, and on licensed self-hosted deployments. Listing grants works on every plan, so a downgraded workspace can still see the grants in place.

put/api/v3/meta/bases/{baseId}/permissions

Request

Path parameters

baseIdstring required

Unique identifier for the base.

Request body

entity'table' | 'field' required

What the grant is attached to.

entity_idstring required

Table ID for entity table, field ID for entity field.

permission'TABLE_VISIBILITY' | 'TABLE_RECORD_ADD' | 'TABLE_RECORD_DELETE' | 'RECORD_FIELD_EDIT' required

TABLE_* keys attach to a table, RECORD_FIELD_EDIT to a field.

granted_type'role' | 'user' | 'nobody' required

role: a minimum base role. user: only the listed subjects. nobody: no one.

granted_role'creator' | 'editor'

Minimum role. Required with granted_type role and rejected otherwise. To restrict to owners, use granted_type user.

enforce_for_automationboolean

Also enforce for automations.

enforce_for_formboolean

Also enforce for form submissions.

Response

The grant as stored.

idstring

Unique identifier for the grant.

entity'table' | 'field'

What the grant is attached to.

entity_idstring

Table ID or field ID.

permission'TABLE_VISIBILITY' | 'TABLE_RECORD_ADD' | 'TABLE_RECORD_DELETE' | 'RECORD_FIELD_EDIT'

TABLE_* keys attach to a table, RECORD_FIELD_EDIT to a field.

granted_type'role' | 'user' | 'nobody'

role: a minimum base role. user: only the listed subjects. nobody: no one.

granted_rolestring nullable

Minimum role for a role grant, else null.

enforce_for_automationboolean
enforce_for_formboolean
created_bystring

Changes