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

[Mohamed Musheer]

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

[Rodrigo Cortez · Accepted solution]

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.

[Rich Sparks · Accepted solution]

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

[Heidi Hendry]

This also works without roleId if you want the user to have the default Team Role for the Team.

{
"op":"add",
"path":"/teams/-",
"value":{
"teamId":1385
}

[Heidi Hendry]

If you ended up here and want to know more about the roleId :
What are the role IDs for different team types when adding users to Teams using APIs?

[Dan Tombs]

Hey @Heidi Hendry

This is really useful. This is definitely something I was getting a little lost on.

Dan