Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,293,245
Community Members
 
Community Events
165
Community Groups

Want to add/remove users from team on jira align using API

Want to know the API for users to add team and remove users from team in jira align.

2 answers

2 accepted

1 vote
Answer accepted

Hi @Mohamed Musheer !

Assuming you have a valid API 2.0 token, and corresponding grants in UI to perform this operation....

 

To add a user to a team, by using Jira Align API 2.0, make the following call:

PATCH https://instance.jiraalign.com/rest/align/api/2/Users/<id>

Where <id> is the userId of your user.

As request body, use the following JSON:

[
{
"op": "add",
"path": "/teams/0",
"value": {
"teamId": 1385,
"roleId": 6
}
}
]

Notice teamId and roleId are mandatory fields.  Each team has its own set of valid roles.  Check your team type and corresponding valid values before issuing this call.

The property path is also important.  As path is an array, you must clearly declare which position (index) you're filling.  So if the user doesn't belong yet to any team, then you must use position (index) 0 (as in the example).  If the user already belongs to, let's say, only one team, then you must use position (index) 1 (the second position, as they start counting from zero) and so on.

 

Removing a team assignment, in turn, is a simpler operation.

Just make the following call:

PATCH https://instance.jiraalign.com/rest/align/api/2/Users/<id>

Where <id> is the userId of your user.

As request body, use the following JSON:

[
{
"op": "remove",
"path": "/teams/0"
}
]

The property path determines which team assignment (index) you want to remove.

0 votes
Answer accepted
Rich Sparks Atlassian Team Mar 29, 2021

In addition to @Rodrigo Cortez 's answer about the specifics, I assume you've read this already and looked at the specific documentation that's available in your Jira Align instance:

https://help.jiraalign.com/hc/en-us/articles/360045371954-Getting-started-with-the-REST-API-2-0

Suggest an answer

Log in or Sign up to answer
TAGS
Community showcase
Published in Jira Align

Rockin' the Roadmap - How to make most of the Roadmap with Jira Align

The roadmap challenge for large scale agile enterprises Regardless of the agile framework you use, the agile enterprise has a massive scale with the challenge to connect hundreds of teams and thous...

2,444 views 7 24
Read article

Community Events

Connect with like-minded Atlassian users at free events near you!

Find an event

Connect with like-minded Atlassian users at free events near you!

Unfortunately there are no Community Events near you at the moment.

Host an event

You're one step closer to meeting fellow Atlassian users at your local event. Learn more about Community Events

Events near you