Set up Jira connector team mappings with the API 2.0

You can now sync team information from Jira Align with a built-in Atlassian teams field, using the API 2.0:

  • Jira Cloud: Team team picker field
  • Jira Data Center: Shared Teams field

To create a team mapping with the API 2.0, send a POST call to align/api/2/Connectors/{ConnectorId}/TeamMappings, using your own Jira Align and Jira team ID to map the teams with one another in the request body:

{ 

    "teamId": 1, // Jira Align team ID

    "externalTeamId": "team-id-1", // Jira built-in team ID

    "externalTeamName": "Jira Team", // User friendly name of the Jira built-in team

    "externalTeamTypeId": 1 // 1 = Jira Cloud, 2 = Jira Data Center

}

Perform the API call for each new mapping that needs to be created.

If needed, you can edit or delete team mappings. First, locate the team mapping ID you’d like to edit using a GET call to align/api/2/connectors/1/teamMappings/.
To edit a team mapping, use a PUT call to the URL of the mapping you’d like to edit, for example:

PUT https://companyname.jiraalign.com/rest/align/api/2/connectors/1/teamMappings/35

Replace companyname.jiraalign.com with your own instance URL, and 35 with the team mapping ID. Use the request body to change mapping information, similar to creating a new mapping.

To delete a team mapping, use a DELETE call to the URL of the mapping you’d like to delete. No request body is needed to delete a team mapping.

For more details, check out the ExternalTeamMapping resource in our Swagger documentation at /rest/align/api/docs/index.html

Was this article helpful?
0 out of 0 found this helpful
Print Friendly Version of this pagePrint Get a PDF version of this webpagePDF

Join the Atlassian Community!

The Atlassian Community is a unique, highly collaborative space where customers and Atlassians come together. Ask questions and get answers, start discussions, and collaborate with thousands of other Jira Align customers. Visit the Jira Align Community Collection today.

Need to contact Jira Align Support? Please open a support request.