Function createComponent

createComponent(
    client: Client,
    parameters: {
        ari?: string;
        assignee?: {
            accountId?: string;
            accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: string[];
                    defaultGroupsDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    defined?: boolean;
                    groupDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    groups?: string[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        assigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        description?: string;
        id?: string;
        isAssigneeTypeValid?: boolean;
        lead?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: string[];
                    defaultGroupsDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    defined?: boolean;
                    groupDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    groups?: string[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        leadAccountId?: string;
        metadata?: Record<string, any>;
        name?: string;
        project?: string;
        projectId?: number;
        realAssignee?: {
            accountId?: string;
            accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: string[];
                    defaultGroupsDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    defined?: boolean;
                    groupDetails?: {
                        groupId?: ...;
                        name?: ...;
                        self?: ...;
                        [key: ...]: ...;
                    }[];
                    groups?: string[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        realAssigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        self?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        ari?: string;
        assignee?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        assigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        description?: string;
        id?: string;
        isAssigneeTypeValid?: boolean;
        lead?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        leadAccountId?: string;
        metadata?: Record<string, any>;
        name?: string;
        project?: string;
        projectId?: number;
        realAssignee?: {
            accountId?: string;
            accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        realAssigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        self?: string;
        [key: string]: unknown;
    },
>
Creates a component. Use components to provide containers for issues within a project. Use components to provide containers for issues within a project.

This operation can be accessed anonymously.

Permissions required: Administer projects project permission for the project in which the component is created or Administer Jira global permission.
Parameters
- client: Client
- parameters: {
      ari?: string;
      assignee?: {
          accountId?: string;
          accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: string]: unknown };
              items?: {
                  defaultGroups?: string[];
                  defaultGroupsDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  defined?: boolean;
                  groupDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  groups?: string[];
                  hasUnlimitedSeats?: boolean;
                  key?: string;
                  name?: string;
                  numberOfSeats?: number;
                  platform?: boolean;
                  remainingSeats?: number;
                  selectedByDefault?: boolean;
                  userCount?: number;
                  userCountDescription?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: string]: unknown };
              items?: {
                  groupId?: string | null;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      assigneeType?: | string & {}
      | "PROJECT_DEFAULT"
      | "COMPONENT_LEAD"
      | "PROJECT_LEAD"
      | "UNASSIGNED";
      description?: string;
      id?: string;
      isAssigneeTypeValid?: boolean;
      lead?: {
          accountId?: string;
          accountType?: "unknown"
          | string & {}
          | "atlassian"
          | "app"
          | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: string]: unknown };
              items?: {
                  defaultGroups?: string[];
                  defaultGroupsDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  defined?: boolean;
                  groupDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  groups?: string[];
                  hasUnlimitedSeats?: boolean;
                  key?: string;
                  name?: string;
                  numberOfSeats?: number;
                  platform?: boolean;
                  remainingSeats?: number;
                  selectedByDefault?: boolean;
                  userCount?: number;
                  userCountDescription?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: string]: unknown };
              items?: {
                  groupId?: string | null;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      leadAccountId?: string;
      metadata?: Record<string, any>;
      name?: string;
      project?: string;
      projectId?: number;
      realAssignee?: {
          accountId?: string;
          accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: { [key: string]: unknown };
              items?: {
                  defaultGroups?: string[];
                  defaultGroupsDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  defined?: boolean;
                  groupDetails?: {
                      groupId?: ...;
                      name?: ...;
                      self?: ...;
                      [key: ...]: ...;
                  }[];
                  groups?: string[];
                  hasUnlimitedSeats?: boolean;
                  key?: string;
                  name?: string;
                  numberOfSeats?: number;
                  platform?: boolean;
                  remainingSeats?: number;
                  selectedByDefault?: boolean;
                  userCount?: number;
                  userCountDescription?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: string;
              "24x24"?: string;
              "32x32"?: string;
              "48x48"?: string;
              [key: string]: unknown;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: { [key: string]: unknown };
              items?: {
                  groupId?: string | null;
                  name?: string;
                  self?: string;
                  [key: string]: unknown;
              }[];
              "max-results"?: number;
              pagingCallback?: { [key: string]: unknown };
              size?: number;
              [key: string]: unknown;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      realAssigneeType?: | string & {}
      | "PROJECT_DEFAULT"
      | "COMPONENT_LEAD"
      | "PROJECT_LEAD"
      | "UNASSIGNED";
      self?: string;
  }
  - Optionalari?: string
    
    Compass component's ID. Can't be updated. Not required for creating a Project Component.
  - Optionalassignee?: {
        accountId?: string;
        accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
            callback?: { [key: string]: unknown };
            items?: {
                defaultGroups?: string[];
                defaultGroupsDetails?: {
                    groupId?: ...;
                    name?: ...;
                    self?: ...;
                    [key: ...]: ...;
                }[];
                defined?: boolean;
                groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                groups?: string[];
                hasUnlimitedSeats?: boolean;
                key?: string;
                name?: string;
                numberOfSeats?: number;
                platform?: boolean;
                remainingSeats?: number;
                selectedByDefault?: boolean;
                userCount?: number;
                userCountDescription?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        appType?: string;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
            callback?: { [key: string]: unknown };
            items?: {
                groupId?: string | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }
    
    OptionalaccountId?: string
    
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
    
    OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"
    
    The user account type. Can take the following values:
    
    atlassian regular Atlassian user account
    
    app system account used for Connect applications and OAuth to represent external systems
    
    customer Jira Service Desk account representing an external service desk
    
    Optionalactive?: boolean
    
    Whether the user is active.
    
    OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: string[];
            defaultGroupsDetails?: {
                groupId?: ...;
                name?: ...;
                self?: ...;
                [key: ...]: ...;
            }[];
            defined?: boolean;
            groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
            groups?: string[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    OptionalappType?: string
    
    The app type of the user account when accountType is 'app'. Can take the following values:
    
    service Service Account
    
    agent Rovo Agent Account
    
    unknown Unknown app type
    
    OptionalavatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    }
    
    Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
    
    Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
    
    Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
    
    Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
    
    OptionaldisplayName?: string
    
    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
    
    OptionalemailAddress?: string
    
    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalexpand?: string
    
    Expand options that include additional user details in the response.
    
    Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    Optionalguest?: boolean
    
    Whether the user is a guest.
    
    Optionallocale?: string
    
    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalself?: string
    
    The URL of the user.
    
    OptionaltimeZone?: string
    
    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
  - OptionalassigneeType?:
        | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED"
    
    The nominal user type used to determine the assignee for issues created with this component. See realAssigneeType for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the following values:
    
    PROJECT_LEAD the assignee to any issues created with this component is nominally the lead for the project the component is in.
    
    COMPONENT_LEAD the assignee to any issues created with this component is nominally the lead for the component.
    
    UNASSIGNED an assignee is not set for issues created with this component.
    
    PROJECT_DEFAULT the assignee to any issues created with this component is nominally the default assignee for the project that the component is in.
    
    Default value: PROJECT_DEFAULT. Optional when creating or updating a component.
  - Optionaldescription?: string
    
    The description for the component. Optional when creating or updating a component.
  - Optionalid?: string
    
    The unique identifier for the component.
  - OptionalisAssigneeTypeValid?: boolean
    
    Whether a user is associated with assigneeType. For example, if the assigneeType is set to COMPONENT_LEAD but the component lead is not set, then false is returned.
  - Optionallead?: {
        accountId?: string;
        accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
            callback?: { [key: string]: unknown };
            items?: {
                defaultGroups?: string[];
                defaultGroupsDetails?: {
                    groupId?: ...;
                    name?: ...;
                    self?: ...;
                    [key: ...]: ...;
                }[];
                defined?: boolean;
                groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                groups?: string[];
                hasUnlimitedSeats?: boolean;
                key?: string;
                name?: string;
                numberOfSeats?: number;
                platform?: boolean;
                remainingSeats?: number;
                selectedByDefault?: boolean;
                userCount?: number;
                userCountDescription?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        appType?: string;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
            callback?: { [key: string]: unknown };
            items?: {
                groupId?: string | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }
    
    OptionalaccountId?: string
    
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
    
    OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"
    
    The user account type. Can take the following values:
    
    atlassian regular Atlassian user account
    
    app system account used for Connect applications and OAuth to represent external systems
    
    customer Jira Service Desk account representing an external service desk
    
    Optionalactive?: boolean
    
    Whether the user is active.
    
    OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: string[];
            defaultGroupsDetails?: {
                groupId?: ...;
                name?: ...;
                self?: ...;
                [key: ...]: ...;
            }[];
            defined?: boolean;
            groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
            groups?: string[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    OptionalappType?: string
    
    The app type of the user account when accountType is 'app'. Can take the following values:
    
    service Service Account
    
    agent Rovo Agent Account
    
    unknown Unknown app type
    
    OptionalavatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    }
    
    Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
    
    Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
    
    Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
    
    Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
    
    OptionaldisplayName?: string
    
    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
    
    OptionalemailAddress?: string
    
    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalexpand?: string
    
    Expand options that include additional user details in the response.
    
    Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    Optionalguest?: boolean
    
    Whether the user is a guest.
    
    Optionallocale?: string
    
    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalself?: string
    
    The URL of the user.
    
    OptionaltimeZone?: string
    
    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
  - OptionalleadAccountId?: string
    
    The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
  - Optionalmetadata?: Record<string, any>
    
    Compass component's metadata. Can't be updated. Not required for creating a Project Component.
  - Optionalname?: string
    
    The unique name for the component in the project. Required when creating a component. Optional when updating a component. The maximum length is 255 characters.
  - Optionalproject?: string
    
    The key of the project the component is assigned to. Required when creating a component. Can't be updated.
  - OptionalprojectId?: number
    
    The ID of the project the component is assigned to.
  - OptionalrealAssignee?: {
        accountId?: string;
        accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
            callback?: { [key: string]: unknown };
            items?: {
                defaultGroups?: string[];
                defaultGroupsDetails?: {
                    groupId?: ...;
                    name?: ...;
                    self?: ...;
                    [key: ...]: ...;
                }[];
                defined?: boolean;
                groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
                groups?: string[];
                hasUnlimitedSeats?: boolean;
                key?: string;
                name?: string;
                numberOfSeats?: number;
                platform?: boolean;
                remainingSeats?: number;
                selectedByDefault?: boolean;
                userCount?: number;
                userCountDescription?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        appType?: string;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
            callback?: { [key: string]: unknown };
            items?: {
                groupId?: string | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }
    
    OptionalaccountId?: string
    
    The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
    
    OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"
    
    The user account type. Can take the following values:
    
    atlassian regular Atlassian user account
    
    app system account used for Connect applications and OAuth to represent external systems
    
    customer Jira Service Desk account representing an external service desk
    
    Optionalactive?: boolean
    
    Whether the user is active.
    
    OptionalapplicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: string[];
            defaultGroupsDetails?: {
                groupId?: ...;
                name?: ...;
                self?: ...;
                [key: ...]: ...;
            }[];
            defined?: boolean;
            groupDetails?: { groupId?: ...; name?: ...; self?: ...; [key: ...]: ... }[];
            groups?: string[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    OptionalappType?: string
    
    The app type of the user account when accountType is 'app'. Can take the following values:
    
    service Service Account
    
    agent Rovo Agent Account
    
    unknown Unknown app type
    
    OptionalavatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    }
    
    Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
    
    Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
    
    Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
    
    Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
    
    OptionaldisplayName?: string
    
    The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
    
    OptionalemailAddress?: string
    
    The email address of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalexpand?: string
    
    Expand options that include additional user details in the response.
    
    Optionalgroups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    }
    
    Optionalguest?: boolean
    
    Whether the user is a guest.
    
    Optionallocale?: string
    
    The locale of the user. Depending on the user’s privacy setting, this may be returned as null.
    
    Optionalself?: string
    
    The URL of the user.
    
    OptionaltimeZone?: string
    
    The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
  - OptionalrealAssigneeType?:
        | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED"
    
    The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set from the assigneeType. For example, assigneeType is set to COMPONENT_LEAD but no component lead is set. This property is set to one of the following values:
    
    PROJECT_LEAD when assigneeType is PROJECT_LEAD and the project lead has permission to be assigned issues in the project that the component is in.
    
    COMPONENT_LEAD when assigneeType is COMPONENT_LEAD and the component lead has permission to be assigned issues in the project that the component is in.
    
    UNASSIGNED when assigneeType is UNASSIGNED and Jira is configured to allow unassigned issues.
    
    PROJECT_DEFAULT when none of the preceding cases are true.
  - Optionalself?: string
    
    The URL of the component.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        ari?: string;
        assignee?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        assigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        description?: string;
        id?: string;
        isAssigneeTypeValid?: boolean;
        lead?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        leadAccountId?: string;
        metadata?: Record<string, any>;
        name?: string;
        project?: string;
        projectId?: number;
        realAssignee?: {
            accountId?: string;
            accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        realAssigneeType?: | string & {}
        | "PROJECT_DEFAULT"
        | "COMPONENT_LEAD"
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        self?: string;
        [key: string]: unknown;
    },
>
- Defined in src/cloud/api/projectComponents.ts:60

Function createComponent

Parameters

Optionalari?: string

OptionalaccountId?: string

OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

Optionalactive?: boolean

OptionalappType?: string

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalexpand?: string

Optionalgroups?: { callback?: { [key: string]: unknown }; items?: { groupId?: string | null; name?: string; self?: string; [key: string]: unknown; }[]; "max-results"?: number; pagingCallback?: { [key: string]: unknown }; size?: number; [key: string]: unknown;}

Optionalguest?: boolean

Optionallocale?: string

Optionalself?: string

OptionaltimeZone?: string

OptionalassigneeType?: | string & {} | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"

Optionaldescription?: string

Optionalid?: string

OptionalisAssigneeTypeValid?: boolean

OptionalaccountId?: string

OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

Optionalactive?: boolean

OptionalappType?: string

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalexpand?: string

Optionalgroups?: { callback?: { [key: string]: unknown }; items?: { groupId?: string | null; name?: string; self?: string; [key: string]: unknown; }[]; "max-results"?: number; pagingCallback?: { [key: string]: unknown }; size?: number; [key: string]: unknown;}

Optionalguest?: boolean

Optionallocale?: string

Optionalself?: string

OptionaltimeZone?: string

OptionalleadAccountId?: string

Optionalmetadata?: Record<string, any>

Optionalname?: string

Optionalproject?: string

OptionalprojectId?: number

OptionalaccountId?: string

OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

Optionalactive?: boolean

OptionalappType?: string

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalexpand?: string

Optionalgroups?: { callback?: { [key: string]: unknown }; items?: { groupId?: string | null; name?: string; self?: string; [key: string]: unknown; }[]; "max-results"?: number; pagingCallback?: { [key: string]: unknown }; size?: number; [key: string]: unknown;}

Optionalguest?: boolean

Optionallocale?: string

Optionalself?: string

OptionaltimeZone?: string

OptionalrealAssigneeType?: | string & {} | "PROJECT_DEFAULT" | "COMPONENT_LEAD" | "PROJECT_LEAD" | "UNASSIGNED"

Optionalself?: string

Settings

`Optional`ari?: string

`Optional`accountId?: string

`Optional`accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

`Optional`active?: boolean

`Optional`appType?: string

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`expand?: string

`Optional`groups?: {
callback?: { [key: string]: unknown };
items?: {
groupId?: string | null;
name?: string;
self?: string;
[key: string]: unknown;
}[];
"max-results"?: number;
pagingCallback?: { [key: string]: unknown };
size?: number;
[key: string]: unknown;
}

`Optional`guest?: boolean

`Optional`locale?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`assigneeType?:
| string & {}
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED"

`Optional`description?: string

`Optional`id?: string

`Optional`isAssigneeTypeValid?: boolean

`Optional`accountId?: string

`Optional`accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

`Optional`active?: boolean

`Optional`appType?: string

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`expand?: string

`Optional`groups?: {
callback?: { [key: string]: unknown };
items?: {
groupId?: string | null;
name?: string;
self?: string;
[key: string]: unknown;
}[];
"max-results"?: number;
pagingCallback?: { [key: string]: unknown };
size?: number;
[key: string]: unknown;
}

`Optional`guest?: boolean

`Optional`locale?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`leadAccountId?: string

`Optional`metadata?: Record<string, any>

`Optional`name?: string

`Optional`project?: string

`Optional`projectId?: number

`Optional`accountId?: string

`Optional`accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

`Optional`active?: boolean

`Optional`appType?: string

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`expand?: string

`Optional`groups?: {
callback?: { [key: string]: unknown };
items?: {
groupId?: string | null;
name?: string;
self?: string;
[key: string]: unknown;
}[];
"max-results"?: number;
pagingCallback?: { [key: string]: unknown };
size?: number;
[key: string]: unknown;
}

`Optional`guest?: boolean

`Optional`locale?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`realAssigneeType?:
| string & {}
| "PROJECT_DEFAULT"
| "COMPONENT_LEAD"
| "PROJECT_LEAD"
| "UNASSIGNED"

`Optional`self?: string