This article provides information about project permissions to help you get started with the API.
Default Account Permissions: Account Administrator
Overview
This article provides information about project permissions to help you get started with the API. For the full documentation, see the Kantata OX API Documentation.
Project Permission Levels
Response
The Participations API response includes fields for access_level and permissions_label The combination of these two fields maps to each project permission level as follows.
| Project Permission Name in UI | access_level Value | permissions_label Value |
|---|---|---|
| Project Administrator | admin |
edit |
| Edit Financials | financial |
edit |
| View Financials | financial |
view_only or view_with_custom * |
| Edit Time and Expenses | time_logging |
edit |
| View Time and Expenses | time_logging |
view_only or view_with_custom * |
| Edit Tasks | collaboration |
edit |
| View Tasks | collaboration |
view_only or view_with_custom * |
* If the user has additional access permissions, the permissions_label will be view_with_custom; otherwise, the permissions_label will be view_only.
Request
When creating or updating participations via the API, the values for the access_level request field correspond to each project permission level as follows.
| Project Permission Name in UI | access_level Value |
|---|---|
| Project Administrator | admin |
| Edit Financials | edit_financials |
| View Financials | view_financials |
| Edit Time and Expenses | edit_time_and_expenses |
| View Time and Expenses | view_time_and_expenses |
| Edit Tasks | edit_tasks |
| View Tasks | view_tasks |
Additional Access Permissions
Response
The additional access permissions are available in the Participations API response. The API field names are as follows.
| Additional Access Name in UI | API Field Name |
|---|---|
| Configure Time & Expense Tracking | Not available |
| Edit To Dos | Not available |
| Invite Members to Project | can_invite |
| Post to Activity Feed | can_post |
| Schedule Hours for Self |
can_schedule_their_hours * |
| Schedule Hours for Team |
can_schedule_team_hours * |
| Track Expenses | can_edit_expense |
| Track Time | can_edit_time |
* Must be requested via the optional_fields parameter.
Request
The additional access permissions can be added or updated using the create participation and update participation endpoints. This is done either via their corresponding fields or via the permissions object as follows.
| Additional Access Name in UI | API Field Name |
|---|---|
| Configure Time & Expense Tracking | Not available |
| Edit To Dos | Not available |
| Invite Members to Project |
can_invite field |
| Post to Activity Feed |
can_post field |
| Schedule Hours for Self |
can_schedule_their_hours field |
| Schedule Hours for Team |
can_schedule_team_hours field |
| Track Expenses | Include can_edit_expense in the permissions object |
| Track Time | Include can_edit_time in the permissions object |
Comments
0 comments
Please sign in to leave a comment.