PermissionSets API breaking change

UPDATE (July 23, 2021): Based on your feedback and to give you more time to align with our API changes, we’ve decided to postpone the breaking changes to our PermissionSets API to September 1, 2021. See the announcement for more.

There are the following breaking changes happening to PermissionSets API:

What is going to change?

1. The Permission Set ID format will be changed from integer to UUID (universally unique identifier) string. This means that the current IDs will be replaced with new values both in the endpoint path and the response body for the following three endpoints:

• GET /v1/permissionSets
• GET /v1/permissionSets/:id
• GET /v1/permissionSets/:id/assignments

2. The response of GET /v1/permissionSets/:id/assignments will no longer include the id field per assignment. An assignment is an object which currently includes the following fields

• id (which will be removed)
• user_id
• permission_set_id
• name (the name of the PermissionSet)

3. Permission Set objects returned from GET /v1/permissionSets and GET /v1/permissionSets/:id will temporarily (for the next 2 months) have an additional field old_id of type integer, which will contain the old ID value

4. Permission Set Assignment objects returned from GET /v1/permissionSets/:id/assignments will temporarily (for the next 2 months) have an additional field permission_set_id_old of type integer, which will contain the old Permission Set ID value

Why is it going to change?

We are updating our data storage in preparation for providing the new Permission Set functionality in the near future.

Who is affected?

All consumers of the listed API endpoints are affected in case they

• specifically expect Permission Set ID to be an integer
• rely on the removed Permission Set Assignment id field

Published on July 8, 2021