Function getGroups

getGroups(
    client: Client,
    parameters: {
        accountIds?: string[];
        counts?: { includeResources?: boolean; includeUsers?: boolean };
        cursor?: string;
        directoryId: string;
        directoryIds?: string[];
        groupIds?: string[];
        limit?: number;
        orgId: string;
        resourceIds?: string[];
        resourceOwners?: string[];
        roleIds?: (
            | string & {}
            | "atlassian/org-admin"
            | "atlassian/site-admin"
            | "atlassian/user-access-admin"
            | "atlassian/ai-access"
            | "atlassian/user"
            | "atlassian/admin"
            | "atlassian/guest"
            | "atlassian/customer"
            | "atlassian/contributor"
            | "atlassian/basic"
            | "atlassian/stakeholder"
        )[];
        searchTerm?: string;
    },
    options?: RequestOptions,
): Promise<
    {
        data?: {
            counts?: {
                resources?: number;
                users?: number;
                [key: string]: unknown;
            };
            description?: string;
            directoryId?: string;
            externalSynced?: boolean;
            id?: string;
            links?: { self?: string
            | null; [key: string]: unknown };
            managedBy?: string;
            managementAccess?: {
                deletable?: boolean;
                modifiable?: boolean;
                readable?: boolean;
                [key: string]: unknown;
            };
            name?: string;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>
This API is deprecated and will no longer work after June 30, 2027. Use the Search for groups in an organization endpoint instead.

Returns a page of groups in an organization that match the supplied parameters.

Scopes

Authorization scopes required: read:groups:admin
Parameters
- client: Client
- parameters: {
      accountIds?: string[];
      counts?: { includeResources?: boolean; includeUsers?: boolean };
      cursor?: string;
      directoryId: string;
      directoryIds?: string[];
      groupIds?: string[];
      limit?: number;
      orgId: string;
      resourceIds?: string[];
      resourceOwners?: string[];
      roleIds?: (
          | string & {}
          | "atlassian/org-admin"
          | "atlassian/site-admin"
          | "atlassian/user-access-admin"
          | "atlassian/ai-access"
          | "atlassian/user"
          | "atlassian/admin"
          | "atlassian/guest"
          | "atlassian/customer"
          | "atlassian/contributor"
          | "atlassian/basic"
          | "atlassian/stakeholder"
      )[];
      searchTerm?: string;
  }
  - OptionalaccountIds?: string[]
    
    A list of user account IDs.
  - Optionalcounts?: { includeResources?: boolean; includeUsers?: boolean }
    
    Whether to include counts of different objects associated with the group.
    
    OptionalincludeResources?: boolean
    
    Whether to include the number of resources associated with the group.
    
    OptionalincludeUsers?: boolean
    
    Whether to include the number of users associated with the group.
  - Optionalcursor?: string
    
    Sets the cursor position to retrieve the next set of results. If present, all other parameters are discarded when searching.
  - directoryId: string
    
    Unique ID associated with a directory. The - character can be used to increase the operation scope to all directories the requestor has permission to manage.
  - OptionaldirectoryIds?: string[]
    
    A list of directory IDs. The requestor must have permissions to administer resources linked to these directories.
  - OptionalgroupIds?: string[]
    
    A list of group IDs.
  - Optionallimit?: number
    
    The desired number of results for the search request.
  - orgId: string
    
    Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
  - OptionalresourceIds?: string[]
    
    A list of resource IDs. The resource IDs should be specified using the Atlassian Resource Identifier (ARI) format. Example ARI: ari:cloud:jira-core::site/1
  - OptionalresourceOwners?: string[]
    
    The list of resource owners to filter the results by. Used to identify resources using their owner to which the user has at least one role assigned to.
  - OptionalroleIds?: (
        | string & {}
        | "atlassian/org-admin"
        | "atlassian/site-admin"
        | "atlassian/user-access-admin"
        | "atlassian/ai-access"
        | "atlassian/user"
        | "atlassian/admin"
        | "atlassian/guest"
        | "atlassian/customer"
        | "atlassian/contributor"
        | "atlassian/basic"
        | "atlassian/stakeholder"
    )[]
    
    A list of role IDs. The Atlassian canonical roles are used to determine the permissions of the user against resources within the organization. The allowed roles are:
    
    atlassian/user - Can access the product, with no product admin permissions
    
    atlassian/admin - Can access the product, with product admin permissions
    
    atlassian/guest - Can only access one space you or space admins specify
    
    atlassian/customer - (Jira Service Management) Can visit help center, submit help requests, and view articles (non-billable)
    
    atlassian/user-access-admin - No product access. Can administer users and groups for this product in Atlassian Administration
    
    atlassian/contributor - Can access the product to view, comment, and vote only (non-billable)
    
    atlassian/basic - Can access basic product features, with no product admin permissions (non-billable)
    
    atlassian/stakeholder - Can receive incident updates and has the same product access as Customer. Non-billable but available only on Premium and Enterprise plans
    
    atlassian/org-admin - An organization admin is the highest level of admin and can complete any administrative task in Atlassian Administration
    
    atlassian/site-admin - Site admins can access Atlassian Administration and complete tasks related to the specific site they are administering.
    
    atlassian/ai-access - Can use AI features in AI-enabled apps they have access to.
  - OptionalsearchTerm?: string
    
    A search term to search the name field.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        data?: {
            counts?: {
                resources?: number;
                users?: number;
                [key: string]: unknown;
            };
            description?: string;
            directoryId?: string;
            externalSynced?: boolean;
            id?: string;
            links?: { self?: string
            | null; [key: string]: unknown };
            managedBy?: string;
            managementAccess?: {
                deletable?: boolean;
                modifiable?: boolean;
                readable?: boolean;
                [key: string]: unknown;
            };
            name?: string;
            [key: string]: unknown;
        }[];
        links?: {
            next?: string
            | null;
            prev?: string | null;
            self?: string | null;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    },
>

Deprecated
This API is deprecated and will no longer work after June 30, 2027. Use the Search for groups in an organization endpoint instead.
- Defined in src/admin/api/groups.ts:276