jira.js
    Preparing search index...

    Function getGroups

    • Get groups from the directory. Filter the groups by name supported with a single exact match (eq) against the displayName attribute.

      Note: While this API enables pagination, sorting functionality is not supported.

      Parameters

      • client: Client
      • parameters: { count?: number; directoryId: string; filter?: string; startIndex?: number }
        • Optionalcount?: number

          Desired maximum number of query results in the list response page.

        • directoryId: string

          The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.

        • Optionalfilter?: string

          Filter for displayName. Example: displayName eq "SCIM_GROUP"

        • OptionalstartIndex?: number

          A 1-based index of the first query result.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              itemsPerPage?: number;
              Resources?: {
                  displayName?: string;
                  externalId?: string;
                  id?: string;
                  members?: {
                      $ref?: string;
                      display?: string;
                      type?: string;
                      value?: string;
                      [key: string]: unknown;
                  }[];
                  meta?: {
                      created?: Date;
                      lastModified?: Date;
                      location?: string;
                      resourceType?: string & {}
                      | "USER"
                      | "GROUP"
                      | "DIRECTORY";
                      [key: string]: unknown;
                  };
                  schemas?: string[];
                  [key: string]: unknown;
              }[];
              schemas?: string[];
              startIndex?: number;
              totalResults?: number;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility