Function getGroupsCount

Parameters

• client: Client
• parameters: {
      accountIds?: string[];
      directoryId: string;
      directoryIds?: string[];
      groupIds?: string[];
      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.

  • 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.

  • 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