npm - @resolution/organizations-api-client - Versions diffs - 0.15.8 → 0.15.9 - Mend

@resolution/organizations-api-client 0.15.8 → 0.15.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/lib/openapi/organizations/services/GroupsService.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import { CommonHttpService } from "../../core/CommonHttpService";
-import { type GroupsSearchRequest, type GroupsSearchPage, type MultiDirectoryGroupPage, type MultiDirectoryGroupDetails, type MultiDirectoryGroupRoleAssignmentPage, type MultiDirectoryGroupStats } from "../models/groups";
+import { type CreateGroupInput, type AddGroupMembershipInput, type GroupRoleAssignmentInput, type GroupsSearchRequest, type GroupsSearchPage, type MultiDirectoryGroupPage, type MultiDirectoryGroupDetails, type MultiDirectoryGroupRoleAssignmentPage, type MultiDirectoryGroupStats } from "../models/groups";
 /**
  * Orgs Groups APIs
  *
@@ -7,6 +7,256 @@ import { type GroupsSearchRequest, type GroupsSearchPage, type MultiDirectoryGro
  * @category Services
  */
 export declare class GroupsService extends CommonHttpService {
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Grant access to group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-assign-post)
+     * instead.
+     *
+     * **The API is available for customers using the [new user management experience
+     * only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**.
+     *
+     * Assign roles that grant product access to groups. Please note that this
+     * operation adheres to eventual consistency, and it might take up to 30 seconds
+     * for changes to take effect.
+     *
+     * @deprecated
+     * @returns Roles were successfully added to the group
+     * @path POST `/v1/orgs/{orgId}/directory/groups/{groupId}/roles/assign`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-groupid-roles-assign-post
+     * @param params
+     */
+    assignRoleToGroup: ({ orgId, groupId, groupRoleAssignmentInput }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID that serves as reference to the group. Use the [Search for groups
+         * within an organization
+         * API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v1-orgs-orgid-groups-search-post)
+         * to get the groupId.
+         */
+        groupId: string;
+        groupRoleAssignmentInput: GroupRoleAssignmentInput;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * Group 12345 added Roles. ROLE `user` for RESOURCE `ari:cloud:identity::group/test-group-uuid1` and ROLE `user-access-admin` for RESOURCE `ari:cloud:identity::group/test-group-uuid2` is in progress. Changes may take up to 30 seconds to reflect.
+         */
+        message: string;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [new Delete group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-groupid-delete)
+     * instead.
+     *
+     * **The API is available for customers using the new user management experience
+     * only. Learn more about the [new user management
+     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**
+     *
+     * This API will:
+     * - Delete a group from the organization's directory.
+     * - Delete the permissions, content access, notification schemes, and roles
+     * granted to the users.
+     *
+     * This API will not:
+     * - Delete groups that are synchronized through SCIM. To delete these groups, you
+     * will need to delete them within your external identity provider. Learn more
+     * about [configuring user provisioning with an identity
+     * provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).
+     * - Delete a group if it’s marked as a [default
+     * group](https://support.atlassian.com/user-management/docs/default-groups-and-permissions).
+     * - Delete `site-admin` group and therefore revoke org-admin role from a user.
+     * - Delete a group if it contains users (unless forced).
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/delete-group/#delete-group).
+     *
+     * @deprecated
+     * @returns Group was successfully deleted from organization's directory.
+     * @path DELETE `/v1/orgs/{orgId}/directory/groups/{groupId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-groupid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryGroupsGroupId: ({ orgId, groupId, forceIfNotEmpty }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID that serves as reference to the group.
+         * Use the [Jira Group Search
+         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get)
+         * to get the groupId (if Jira is available for your Organization). **Jira APIs
+         * use a different [authentication method
+         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
+         * If you don’t have Jira, export a .csv of the user list. Make sure to select
+         * **pivot to column** when prompted. Learn how to [export users from a
+         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
+         */
+        groupId: string;
+        /**
+         * Groups cannot be deleted if it contains users, unless `forceIfNotEmpty=true` is
+         * provided
+         */
+        forceIfNotEmpty?: boolean | undefined;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * Group 0980d761-fce5-4ea1-83e4-9cc8f5db92ae was removed
+         */
+        message?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [new Remove user from group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-groupid-memberships-accountid-delete)
+     * instead.
+     *
+     * **The API is available for customers using the new user management experience
+     * only. Learn more about the [new user management
+     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**
+     *
+     * This API will:
+     * - Remove user from a group.
+     * - Remove multiple permissions for user at once.
+     * - Easily manage permissions, content access, notification schemes, and roles.
+     *
+     * This API will not:
+     * - Make modifications to group memberships that are synchronized through SCIM.
+     * To make changes to these memberships, you will need to modify them within your
+     * external identity provider. Learn more about [configuring user provisioning
+     * with an identity
+     * provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).
+     * - Modify `site-admin` group and therefore revoke org-admin role from a user.
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/remove-user-to-group/).
+     *
+     * @deprecated
+     * @returns User was successfully removed from the group in the organization directory.
+     * @path DELETE `/v1/orgs/{orgId}/directory/groups/{groupId}/memberships/{accountId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-groupid-memberships-accountid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryGroupsGroupIdMembershipsAccountId: ({ orgId, groupId, accountId }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID that serves as reference to the group.
+         * Use the [Jira Group Search
+         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get)
+         * to get the groupId (if Jira is available for your Organization). **Jira APIs
+         * use a different [authentication method
+         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
+         * If you don’t have Jira, export a .csv of the user list. Make sure to select
+         * **pivot to column** when prompted. Learn how to [export users from a
+         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
+         */
+        groupId: string;
+        /**
+         * Unique ID of the user's account that you are adding to the group.
+         * Use the [Jira User Search
+         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get)
+         * to get the accountId (if Jira is available for your Organization). **Jira APIs
+         * use a different [authentication method
+         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
+         * If you don’t have Jira, export a .csv of the user list. Learn how to [export
+         * users from a
+         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
+         */
+        accountId: string;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * User 63ec0aa0c5061c632c0cddde was removed from group fca77b90-a2a9-4385-961b-1377b3dbeb0b
+         */
+        message?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Delete a group from a directory if you don’t need this group anymore. This
+     * removes any app access and permissions granted by this group from all members.
+     * A member can still access an app if they’re in another group that grants access
+     * to the same app.
+     *
+     * @path DELETE `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-delete
+     * @param params
+     */
+    deleteV2OrgsOrgIdDirectoriesDirectoryIdGroupsGroupId: ({ orgId, directoryId, groupId }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * A group has a unique ID. Use the [Get groups
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+         * to find the group ID.
+         */
+        groupId: string;
+    }) => Promise<void>;
+    /**
+     * Remove a user from a group. This removes any app access and permissions granted
+     * by this group, but the user may still be in other groups that grant the same
+     * app access and permissions.
+     *
+     * @path DELETE `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/memberships/{accountId}"`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-memberships-accountid-delete
+     * @param params
+     */
+    deleteV2OrgsOrgIdDirectoriesDirectoryIdGroupsGroupIdMembershipsAccountId: ({ orgId, directoryId, groupId, accountId }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * A group has a unique ID. Use the [Get groups
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+         * to find the group ID.
+         */
+        groupId: string;
+        /**
+         * Every user has a unique ID. Find a user’s account ID by using the [Get users
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
+         */
+        accountId: string;
+    }) => Promise<void>;
     /**
      * Returns the details of a group.
      *
@@ -17,8 +267,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     getGroup: ({ orgId, directoryId, groupId }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**
@@ -41,8 +291,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     getGroupRoleAssignments: ({ orgId, directoryId, groupId, cursor, limit, directoryIds, resourceOwners, resourceIds, roleIds }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**
@@ -114,7 +364,7 @@ export declare class GroupsService extends CommonHttpService {
          *    - `atlassian/ai-access` - Can use AI features in AI-enabled apps they have
          * access to.
          */
-        roleIds?: ("atlassian/user" | "atlassian/user-access-admin" | "atlassian/admin" | "atlassian/guest" | "atlassian/contributor" | "atlassian/customer" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/site-admin" | "atlassian/org-admin" | "atlassian/ai-access")[] | undefined;
+        roleIds?: ("atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access")[] | undefined;
     }) => Promise<MultiDirectoryGroupRoleAssignmentPage>;
     /**
      * Returns a page of groups in an organization that match the supplied parameters.
@@ -126,8 +376,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     getGroups: ({ orgId, directoryId, cursor, limit, directoryIds, accountIds, groupIds, resourceOwners, resourceIds, searchTerm, counts, sortBy, roleIds }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**
@@ -192,7 +442,7 @@ export declare class GroupsService extends CommonHttpService {
          */
         sortBy?: ({
             /** The name of the field to sort the results by. */
-            field: "name" | "description";
+            field: "name";
             /** The direction to sort the results by. */
             direction: "asc" | "desc";
         } & {
@@ -224,7 +474,7 @@ export declare class GroupsService extends CommonHttpService {
          *    - `atlassian/ai-access` - Can use AI features in AI-enabled apps they have
          * access to.
          */
-        roleIds?: ("atlassian/user" | "atlassian/user-access-admin" | "atlassian/admin" | "atlassian/guest" | "atlassian/contributor" | "atlassian/customer" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/site-admin" | "atlassian/org-admin" | "atlassian/ai-access")[] | undefined;
+        roleIds?: ("atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access")[] | undefined;
     }) => Promise<MultiDirectoryGroupPage>;
     /**
      * Returns the count of groups in an organization that match the supplied
@@ -237,8 +487,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     getGroupsCount: ({ orgId, directoryId, directoryIds, accountIds, groupIds, resourceOwners, resourceIds, searchTerm, roleIds }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**
@@ -295,7 +545,7 @@ export declare class GroupsService extends CommonHttpService {
          *    - `atlassian/ai-access` - Can use AI features in AI-enabled apps they have
          * access to.
          */
-        roleIds?: ("atlassian/user" | "atlassian/user-access-admin" | "atlassian/admin" | "atlassian/guest" | "atlassian/contributor" | "atlassian/customer" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/site-admin" | "atlassian/org-admin" | "atlassian/ai-access")[] | undefined;
+        roleIds?: ("atlassian/user" | "atlassian/admin" | "atlassian/guest" | "atlassian/customer" | "atlassian/contributor" | "atlassian/basic" | "atlassian/stakeholder" | "atlassian/org-admin" | "atlassian/site-admin" | "atlassian/user-access-admin" | "atlassian/ai-access")[] | undefined;
     }) => Promise<{
         /** The total number of groups matching the criteria. */
         count?: number | undefined;
@@ -312,8 +562,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     getGroupsStats: ({ orgId, directoryId }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**
@@ -324,6 +574,343 @@ export declare class GroupsService extends CommonHttpService {
         directoryId: string;
     }) => Promise<MultiDirectoryGroupStats>;
     /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [new Create group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-post)
+     * instead.
+     *
+     * **The API is available for customers using the new user management experience
+     * only. Learn more about the [new user management
+     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**
+     *
+     * This API will:
+     * - Create a group in the organization's directory.
+     * - Create a collection of users that you can use to easily manage permissions,
+     * content access, notification schemes, and roles.
+     *
+     * **The creation of new groups using existing group names is not permitted.**
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/create-group/#create-group).
+     *
+     * @deprecated
+     * @returns Request to create group was successfully accepted and will be eventually created in the organization directory.
+     * @path POST `/v1/orgs/{orgId}/directory/groups`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryGroups: ({ orgId, createGroupInput }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        createGroupInput: CreateGroupInput;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * Group test-group was created
+         */
+        message?: string | undefined;
+        /**
+         * The unique identifier of the group.
+         *
+         * @example
+         * f29c72a8-7681-4ed0-8a2c-83372bf67437
+         */
+        groupId?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [new Add user to group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-groupid-memberships-post)
+     * instead.
+     *
+     * **The API is available for customers using the new user management experience
+     * only. Learn more about the [new user management
+     * experience](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592).**
+     *
+     * This API will:
+     * - Add user to a group.
+     * - Assign multiple permissions to user at once.
+     * - Easily manage permissions, content access, notification schemes, and roles.
+     *
+     * This API will not:
+     * - Make modifications to group memberships that are synchronized through SCIM.
+     * To make changes to these memberships, you will need to modify them within your
+     * external identity provider. Learn more about [configuring user provisioning
+     * with an identity
+     * provider](https://support.atlassian.com/provisioning-users/docs/configure-user-provisioning-with-an-identity-provider/).
+     * - Add a user to a group that gives access to a product which is breaching it's
+     * license limit.\
+     * To make these changes, you will need to [remove
+     * users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-groups-groupid-memberships-accountid-delete)
+     * from the group or
+     * [suspend
+     * users](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post)
+     * that are in the group first.\
+     * You can also [manage your
+     * subscription](https://support.atlassian.com/subscriptions-and-billing/resources/)
+     * for the breaching product to increase your license limits.
+     * - Add a user to any group when your organisation has too many products that are
+     * breaching their license limits.
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/add-user-to-group/).
+     *
+     * @deprecated
+     * @returns User was successfully added to the group in the organization directory.
+     * @path POST `/v1/orgs/{orgId}/directory/groups/{groupId}/memberships`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-groupid-memberships-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryGroupsGroupIdMemberships: ({ orgId, groupId, addGroupMembershipInput }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID that serves as reference to the group.
+         * Use the [Jira Group Search
+         * API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-groups-picker-get)
+         * to get the groupId (if Jira is available for your Organization). **Jira APIs
+         * use a different [authentication method
+         * ](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).**
+         * If you don’t have Jira, export a .csv of the user list. Make sure to select
+         * **pivot to column** when prompted. Learn how to [export users from a
+         * site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/).
+         */
+        groupId: string;
+        addGroupMembershipInput: AddGroupMembershipInput;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * User 637194fa77acd224b33bfae3 was added to group 9233fb03-53cc-4463-9698-047aedbffb5c
+         */
+        message?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * Create a group in a directory to manage app access and permissions for multiple
+     * users together.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/groups`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdGroups: ({ orgId, directoryId, requestBody }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        requestBody: {
+            /** Name the group. */
+            name: string;
+            /** Describe what the group is or what it might be used for. */
+            description?: string | undefined;
+        } & {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    /**
+     * Add a user to a group. This gives the user the same app access and permissions
+     * as the group. The user must be in the same directory as the group.
+     *
+     * You can’t add a user to a group synced from an identity provider. Manage this
+     * group in your identity provider instead.
+     *
+     * You can’t add a user to a group if you’ve exceeded your user limit for an app
+     * that the group grants access to. Increase your user limit or suspend another
+     * user from the app first.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/memberships`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-memberships-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdGroupsGroupIdMemberships: ({ orgId, directoryId, groupId, requestBody }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * A group has a unique ID. Use the [Get groups
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+         * to find the group ID.
+         */
+        groupId: string;
+        requestBody: {
+            /**
+             * Every user has a unique ID. Find a user’s account ID by using the [Get users
+             * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-get).
+             */
+            accountId: string;
+        } & {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    /**
+     * Assign a role to a group to assign all members the same role.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments/assign`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-assign-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdGroupsGroupIdRoleAssignmentsAssign: ({ orgId, directoryId, groupId, requestBody }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * A group has a unique ID. Use the [Get groups
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+         * to find the group ID.
+         */
+        groupId: string;
+        requestBody: {
+            /**
+             * A resource or workspace refers to a specific instance of an Atlassian app,
+             * which has a unique ID. Use the [Get workspaces
+             * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post)
+             * to find the resource ID.
+             */
+            resourceId: string;
+            /**
+             * Valid values: atlassian/user, atlassian/user-access-admin, atlassian/admin,
+             * atlassian/guest, atlassian/contributor, atlassian/customer, atlassian/basic,
+             * atlassian/stakeholder, atlassian/viewer
+             */
+            roleId: string;
+        } & {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    /**
+     * Revoke a role from a group to remove access to an app from all members. A
+     * member can still access the app if they’re in another group that grants access
+     * to the same app.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/groups/{groupId}/role-assignments/revoke'`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-revoke-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdGroupsGroupIdRoleAssignmentsRevoke: ({ orgId, directoryId, groupId, requestBody }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * A directory has a unique ID. Use the [Get directories
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v2-orgs-orgid-directories-get)
+         * to find the directory ID.
+         */
+        directoryId: string;
+        /**
+         * A group has a unique ID. Use the [Get groups
+         * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+         * to find the group ID.
+         */
+        groupId: string;
+        requestBody: {
+            /**
+             * A resource or workspace refers to a specific instance of an Atlassian app,
+             * which has a unique ID. Use the [Get workspaces
+             * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-workspaces/#api-v2-orgs-orgid-workspaces-post)
+             * to find the resource ID.
+             */
+            resourceId: string;
+            /**
+             * Valid values: atlassian/user, atlassian/user-access-admin, atlassian/admin,
+             * atlassian/guest, atlassian/contributor, atlassian/customer, atlassian/basic,
+             * atlassian/stakeholder, atlassian/viewer
+             */
+            roleId: string;
+        } & {
+            [key: string]: unknown;
+        };
+    }) => Promise<void>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Remove access from group
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-groupid-role-assignments-revoke-post)
+     * instead.
+     *
+     * **The API is available for customers using the [new user management experience
+     * only](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**.
+     *
+     * Revoke roles that provide product access to groups. It's important to note that
+     * this operation follows eventual consistency principles and may require up to 30
+     * seconds to take effect.
+     *
+     * @deprecated
+     * @returns Roles were successfully removed from the group
+     * @path POST `/v1/orgs/{orgId}/directory/groups/{groupId}/roles/revoke`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups#api-v1-orgs-orgid-directory-groups-groupid-roles-revoke-post
+     * @param params
+     */
+    revokeRoleToGroup: ({ orgId, groupId, groupRoleAssignmentInput }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * Unique ID that serves as reference to the group. Use the [Search for groups
+         * within an organization
+         * API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v1-orgs-orgid-groups-search-post)
+         * to get the groupId.
+         */
+        groupId: string;
+        groupRoleAssignmentInput: GroupRoleAssignmentInput;
+    }) => Promise<{
+        /**
+         * A description of the entities affected, and changes made as a result of calling
+         * this API.
+         *
+         * @example
+         * Group 12345 revoked Roles. ROLE1 for RESOURCE1 and ROLE2 for RESOURCE2 is in progress. Changes may take up to 30 seconds to reflect.
+         */
+        message: string;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Get groups in an organization
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-groups/#api-v2-orgs-orgid-directories-directoryid-groups-get)
+     * instead.
+     *
      * **The API is available for customers using the new user management experience
      * only. [How the new user management experience
      * works](https://community.atlassian.com/t5/Atlassian-Access-articles/User-management-for-cloud-admins-just-got-easier/ba-p/1576592)**
@@ -331,6 +918,7 @@ export declare class GroupsService extends CommonHttpService {
      * Returns a list of groups within an organization, offering search functionality
      * through multiple parameters for more precise results.
      *
+     * @deprecated
      * @returns Organization found. Response contains group search results
      *
      * example: " groups_search_response":
@@ -355,8 +943,8 @@ export declare class GroupsService extends CommonHttpService {
      */
     searchGroups: ({ orgId, groupsSearchRequest }: {
         /**
-         * Your organization is identified by a Unique ID. You get your organization ID
-         * and Organization API key simultaneously.
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
          */
         orgId: string;
         /**