Field permissions

Changed on

Update permissions for writing field values and form visibility for a specific field. This endpoint is used to restrict the ability to modify field values to the roles defined. It also makes it possible to decide if the field can be exposed in forms or not.

This is a enterprise feature.

patch/api/field-permissions/{field_id}/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/field-permissions/{field_id}/
  • Auth
    HTTP bearer

Path parameters

field_idinteger required

The ID of the field to update the permissions for.

Request body

role'ADMIN' | 'BUILDER' | 'EDITOR' | 'CUSTOM' | 'NOBODY'
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • CUSTOM - Custom
  • NOBODY - Nobody
allow_in_formsboolean

Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'.

Response

role'ADMIN' | 'BUILDER' | 'EDITOR' | 'CUSTOM' | 'NOBODY' required
  • ADMIN - Admin
  • BUILDER - Builder
  • EDITOR - Editor
  • CUSTOM - Custom
  • NOBODY - Nobody
allow_in_formsboolean

Whether to allow this field to be shown in forms. Default is False. This setting is only relevant if the role is not 'EDITOR'.

field_idinteger required

The ID of the field whose permissions were updated.

can_write_valuesboolean

Whether the user can write values to this field.

Changes

  • e81714236040Revision changes
    • info

      the endpoint scheme security UserSource JWT was removed from the API

    • info

      added the new core.Agent enum value to the request property // (media type: application/json)

    • info

      added the new core.Agent enum value to the request property // (media type: application/x-www-form-urlencoded)

    • info

      added the new core.Agent enum value to the request property // (media type: multipart/form-data)

    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status

  • 51b737b57ec4Revision changes
    • info

      added to the // response property allOf list for the response status

    • info

      removed from the // response property allOf list for the response status