Add or remove Team Member via API in Jira Align
Summary
In Jira Align, it is possible to add or remove a Team Member from a specific team via the Jira Align REST API.
Solution
Whether you're adding or removing a team member, the request method and endpoint used are the same: /rest/align/api/2/Users/ID
The only difference will be the data being sent to the endpoint. See our examples for adding and removing members below:
Add a Team Member
This request is fairly straightforward. From our example, you'll need to substitute the appropriate values for the team and role as matches your instance data.
Request method:
PATCHEndpoint:
https://<Jira_Align_baseUrl/align/api/2/Users/<user_ID>
Request Payload:
[
{
"op": "add",
"path": "/teams/0",
"value":{
"teamId": 6276,
"teamName": "CM Dev Team",
"teamType": 1,
"roleId": 1,
"roleName": "ScrumMaster"
}
]Remove a Team member
Here, the request is a little more complicated. The path must point to the index of the team that needs to be removed based on in the user's Teams array. To identify the index, run a GET for the user record and observe the list of teams and their order in the array. For more detailed instructions, please refer to our documentation How to fetch teams and users using Jira Align API.
Next, to remove the first team in the list (index 0) you would use:
“path:”/teams/0
For the second team in the list (index 1) you would use:
“path:”/teams/1
Follow this logic for any teams that need to be removed. Keep in mind removals must be done one at a time, and the index values will change each time a team is removed. Make sure to check the new positions in the Teams list each time a team is removed.
Request method: PATCH
Endpoint:
https://<Jira_Align_baseUrl/align/api/2/Users/<user_ID>
Request payload:
[
{
"op":"remove",
"path":"/teams/0",
}
]Additional resources
Was this helpful?