[Advanced Notice] Adding write privileges to Custom Fields

Community Forum English Developers & API Platform News
1

tl;dr:

  • custom fields will have different write privileges in the future (for the values, and for the custom field definitions attached to projects or portfolios)
  • no immediate action is required, and most custom fields will not be affected

Hey folks,

We are working on changes to custom fields that will introduce a new write privilege model for custom field values and for the field definitions. Here’s what you need to know about changes that will occur in the future.

Current Behavior

  • if a user can modify the values of a custom field in a task, then an app authorized on behalf of that user can perform the same actions
  • if a user can modify the definitions of the custom field for a project (using the “customize” menu), then an app authorized on behalf of that user can perform the same action

New Behavior

  • an app authorized on behalf of a user may be able to perform greater or fewer actions on a custom field value in a task than the user
  • an app authorized on behalf of a user may be able to perform greater or fewer actions on the custom field definition in a project or portfolio than the user
  • new fields on Custom Field that communicate these write privileges (more details about this in a future announcement)

Unchanged Behavior

  • custom field types remain the same
  • if a user can read the values of a custom field, then an app authorized on behalf of that user can read the value too
  • if a user can read the definition of the custom field for a project, then an app authorized on behalf of that user can read the definition too

Impact

  • once the new behavior launches, some requests affecting custom fields that previously succeeded may fail, if the custom field has write privileges
  • most requests updating the values of custom fields on tasks or modifying the field definitions should be unaffected

Suggestions for a Smooth Migration

  • check Asana-Change headers to stay up-to-date
  • check for a future announcement on the forum sharing what the new field on Custom Field will be
  • handle 4XX errors appropriately
  • do not assume an app can modify the value of a custom field
  • do not assume the user can modify the value of a custom field
  • do not assume an app can modify the custom field definitions
  • do not assume a user can modify the custom field definitions

Timeline

Date Milestone
2023-04-17 Advanced Notice
May or June Announcements

Yours in Developer Relations,
Sasha, on behalf of the Asana API Team

4 Likes