jira.js
    Preparing search index...

    Function addUserToGroup

    • Adds a user to a group.

      Permissions required: Site administration (that is, member of the site-admin group).

      Parameters

      • client: Client
      • parameters: { accountId?: string; groupId?: string; groupname?: string }
        • OptionalaccountId?: string

          The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.

        • OptionalgroupId?: string

          The ID of the group. This parameter cannot be used with the groupName parameter.

        • Optionalgroupname?: string

          As a group's name can change, use of groupId is recommended to identify a group. The name of the group. This parameter cannot be used with the groupId parameter.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              expand?: string;
              groupId?: string
              | null;
              name?: string;
              self?: string;
              users?: {
                  "end-index"?: number;
                  items?: {
                      accountId?: string;
                      accountType?: string;
                      active?: boolean;
                      avatarUrls?: {
                          "16x16"?: string;
                          "24x24"?: string;
                          "32x32"?: string;
                          "48x48"?: string;
                          [key: string]: unknown;
                      };
                      displayName?: string;
                      emailAddress?: string;
                      self?: string;
                      timeZone?: string;
                      [key: string]: unknown;
                  }[];
                  "max-results"?: number;
                  size?: number;
                  "start-index"?: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility