Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

What are the role IDs for different team types when adding users to Teams using APIs?

Samit Mehta _321 Gang_
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 25, 2022

I was successfully able to use the approach described in the answer to the following question.  However, I was able to only figure out one role ID (for Team of Team role in the Program Team).


https://community.atlassian.com/t5/Jira-Align-questions/Want-to-add-remove-users-from-team-on-jira-align-using-API/qaq-p/1650568

The response mentions that one has to specify a role ID, but it didn't mention how to determine the valid role IDs for each type of Team (e.g. Portfolio Team, Program Team, etc).

What are the valid role ids for the various team types?

 

2 answers

1 accepted

5 votes
Answer accepted
Heidi Hendry
Rising Star
Rising Star
Rising Stars are recognized for providing high-quality answers to other users. Rising Stars receive a certificate of achievement and are on the path to becoming Community Leaders.
July 25, 2022

Hi Samit,

For System Roles, the ID for the role can be found by navigating to Administration > Role > find the Role, and then it will appear.

role1.png


For Team Roles:

Team Level  roleId
Analyst 10
Architect 8
Developer 4
Documentation 11
Product Owner 6
QA Lead 2
Scrum Master 1
Stakeholder 9
Team Coach 7
Tester 5
UX 13
Program Level  
Release Train Engineer 14
Stakeholder 9
Team of Team 12
Portfolio Level  
Business Owner 15
Enterprise Architect 16
Epic Owner 17

 

These Role Ids are static across teams and levels. Eg Stakeholder at Team Level and at Program Level has roleID =9

 

For your reference, you can do a "GET" on a user and it will pull back the following information

"teams": [
{
"teamId": 1641,
"teamName": "Portfolio 1 Team",
"teamType": 5,
"roleId": 12,
"roleName": "TeamOfTeam"
}
]
Here you can see that this user has the "TeamOfTeam" role which is roleId = 12 in the "Portfolio 1 Team" which has teamId = 1641.

0 votes
Heidi Hendry January 18, 2024

If you are adding users to teams, and want the user to have the default Team Role for the Team, then exclude the roleId line from the JSON body of your API request

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

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events