Changelog
Start typing to search…
Back to All
improved

Upcoming Permission changes affecting API v1 & v0

10 months ago by Tony Rule

Please read this article to learn more about some upcoming permission changes in Runn and how they may affect your integration.

🚧

Across the next few months, we will be undertaking some improvements to user permissions in Runn. Learn more

API v1

GET /users

  • The "type" of some users will be renamed
    • "Editor" & "Viewer All" will be consolidated into a new type called "Manager"
    • "Viewer Basic" and "Timesheet Only" will be consolidated into a new type called "Contributor"
  • Some of the permission properties have already been expanded for some users in your organisation. These new permissions properties are needed for the upcoming "Manager" user type that will replace the "Editor" and "Viewer All" account types. Unless you are utilising these properties specifically you won't need to make any changes to your integration.

Here is an example of the permissions for an existing Editor that has access to manage specific projects

"permissions": { "type": "editor", "financial": "none", "editProjects": "specific", "manageProjects": "restricted", "editOthers": "none", "manageOthers": "none" }

Once the permissions rollout is complete you'll notice the "type" of some users will change to the new user types being introduced (ie. Manager & Contributor). For the user above you'll just notice the "type" changes to "manager".

"permissions": { "type": "manager", "financial": "none", "editProjects": "specific", "manageProjects": "restricted", "editOthers": "none", "manageOthers": "none" }


POST /invitations

We'll soon be releasing the v1 version of POST /invitations and this will use the new user types and permissions. Once released the API Reference will contain all the details of this new API v1 endpoint.


API v0

POST /api/v0/invitations

  • Existing permission types that are used with POST /api/v0/invitations will continue to be accepted and will mapped to their equivalent new user type.

We recommend migrating to API v1 to take advantage of the new permission types as soon as you can. API v0 is being sunset on January 6, 2025.

GET /api/v0/users

Similar to API v1 the GET users endpoint will include

  • Changes include the "type" and some permission properties - see the notes above

Support

If you have any questions. You can reach us at [email protected]