Skip to content

Function: linkTeamToExternalSource() ​

ts
function linkTeamToExternalSource(
   client, 
   parameters, 
   options?
): Promise<void>;

Defined in: src/teams/api/externalTeams.ts:55

Links an existing team to an external reference, and membership and team name will be synced with the external reference.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ externalReference: { id: string; source: string & object | "ATLASSIAN_GROUP"; }; orgId: string; siteId?: string | null; teamId: string; }-
parameters.externalReference{ id: string; source: string & object | "ATLASSIAN_GROUP"; }-
parameters.externalReference.id?string-
parameters.externalReference.source?string & object | "ATLASSIAN_GROUP"-
parameters.orgId?stringThe ID of the organisation the team and external reference to be linked belongs to.
parameters.siteId?string | nullThe siteId to help locate the externalReference. For example, when the externalReference is a group belonging to a site. [Deprecated] Omitting siteId is deprecated. With the introduction of Units, orgId alone is no longer sufficient to resolve the scope of teams. Always provide a valid siteId to ensure this operation continues to work in the future.
parameters.teamId?stringThe ID of the team to be linked.
options?RequestOptions-

Returns ​

Promise<void>