Jira Align API - How to solve 403 error when fetching Programs
Summary
When attempting to gather Program/ART information using a valid token through the API endpoint GET /align/API/2/Programs/<Program ID>
, a user may encounter a 403 (Forbidden) error, even if they have full access to the Program/ART in the UI.
Environment
Jira Align
Solution
The API endpoints are aligned with user role UI permissions. If a user cannot access a page in the UI, they will likely be blocked when attempting to gather information from that page using the API. For users needing to access Program/ART information through the API, there are two possible solutions:
Grant Administrative Permissions:
Provide the user with administrative permissions to allow API access. The endpoint
GET /align/API/2/Programs
corresponds to the page Administration > Programs and requires toggling on the following administrative permissions Administration > Roles > [User Role] > Administration > Other Setups > Programs.Alternative API Call:
If you prefer not to grant access to the administration area, there is an alternative approach. Since each Program/ART created in Administration > Programs results in a corresponding Program/ART team, follow these steps:
Navigate to the Teams grid.
Search for the Program/Art team's name and obtain its ID.
Execute the API call
GET /align/api/2/Teams/{Program/ART team ID}
.
This API call will retrieve all relevant program data associated with the Program/ART.