jira.js
    Preparing search index...

    Function createTeam

    • Creates a team, and adds the requesting user as the initial member.

      Parameters

      • client: Client
      • parameters: {
            description: string;
            displayName: string;
            orgId: string;
            siteId?: string | null;
            teamType:
                | string & {}
                | "EXTERNAL"
                | "OPEN"
                | "MEMBER_INVITE"
                | "ORG_ADMIN_MANAGED";
        }
        • description: string
        • displayName: string
        • orgId: string

          The ID of the organisation the team is to be created under.

        • OptionalsiteId?: string | null

          If the org mandates site-scoped teams, a site ID must be provided or the operation will fail. [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.

        • teamType: string & {} | "EXTERNAL" | "OPEN" | "MEMBER_INVITE" | "ORG_ADMIN_MANAGED"
      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              creatorId?: string
              | null;
              description: string;
              displayName: string;
              externalReference?:
                  | {
                      id: string;
                      source: string & {}
                      | "ATLASSIAN_GROUP"
                      | "HRIS";
                      [key: string]: unknown;
                  }
                  | null;
              members: { accountId: string; [key: string]: unknown }[];
              organizationId: string;
              state: string & {} | "ACTIVE" | "ARCHIVED";
              teamId: string;
              teamType:
                  | string & {}
                  | "EXTERNAL"
                  | "OPEN"
                  | "MEMBER_INVITE"
                  | "ORG_ADMIN_MANAGED";
              userPermissions: {
                  ADD_MEMBERS: boolean;
                  DELETE_TEAM: boolean;
                  REMOVE_MEMBERS: boolean;
                  UPDATE_TEAM: boolean;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >