@resolution/organizations-api-client 0.15.8 → 0.16.0

package/lib/openapi/organizations/services/UsersService.d.ts

@@ -1,5 +1,6 @@
+import * as commonHttpClient from "../../core/CommonHttpClient";
 import { CommonHttpService } from "../../core/CommonHttpService";
-import { type UserPage, type UsersSearchRequest, type UsersSearchPage, type MultiDirectoryUserPage, type MultiDirectoryUserRoleAssignmentPage, type MultiDirectoryUserStats } from "../models/users";
+import { type UserProductAccessActivityPage, type UserPage, type OrganizationLevelRoleApiRequest, type RoleApiRequest, type InviteApiRequest, type UsersSearchRequest, type UsersSearchPage, type MultiDirectoryUserPage, type MultiDirectoryUserRoleAssignmentPage, type MultiDirectoryUserStats, type MultidirectoryInviteApiRequest, type MultidirectoryInviteSuccessResponse } from "../models/users";
 /**
  * Orgs Users APIs
  *
@@ -8,17 +9,127 @@ import { type UserPage, type UsersSearchRequest, type UsersSearchPage, type Mult
  */
 export declare class UsersService extends CommonHttpService {
     /**
-     * Returns a page of users in an organization that match the supplied parameters.
+     * **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)**.
      *
-     * @returns Returned if the request is successful.
+     * This API can be used to grant Platform Roles to a user.
+     *
+     * @path POST `/v1/orgs/{orgId}/users/{userId}/roles/assign`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-roles-assign-post
+     * @param params
+     */
+    assignRole: ({ orgId, userId, roleApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * The UserId on which the action(Role Assign) needs to happen. Use the [Search
+         * for users within an organization
+         * API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-get)
+         * to get the userId.
+         */
+        userId: string;
+        roleApiRequest: RoleApiRequest;
+    }) => Promise<void>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Remove user from directory
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-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).
+     *
+     * Specifications:
+     * - Remove user access to products listed in Atlassian Administration.
+     * - Remove users from **Users** and **Groups** in **Directory**.
+     * - Make product licenses available for active users.
+     *
+     * The users are not removed immediately; instead, they are placed in a queue for
+     * deletion. Please note that it may take some time for all users to be completely
+     * removed.
+     *
+     * Users with emails whose domain is claimed can still be found in **Managed
+     * accounts** in **Directory**.
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/remove-user/).
+     *
+     * @deprecated
+     * @path DELETE `/v1/orgs/{orgId}/directory/users/{accountId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryUsersAccountId: ({ orgId, 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 of the user's account that you are deleting.
+         * 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<void>;
+    /**
+     * Remove a user from a directory if you don’t want them to appear in your
+     * directory or have access to your apps anymore. You’re not billed for a user
+     * once they’re removed.
+     * You must invite the user to your organization again if you want to reinstate
+     * their access to your apps. You’ll need to assign their roles and group
+     * memberships again.
+     *
+     * @path DELETE `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-delete
+     * @param params
+     */
+    deleteV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountId: ({ orgId, directoryId, 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;
+        /**
+         * 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>;
+    /**
+     * Return a page of users in your organization that match the supplied parameters.
+     * By default, users in all your directories and all your managed accounts are
+     * returned (including managed accounts that aren’t in a directory).
+     *
+     * To get users in a directory only, use the `directoryIds` field. To get your
+     * managed accounts, regardless if they’re in a directory or not, use the
+     * `claimStatus` field.
+     *
+     * @returns Success
      * @path GET `/v2/orgs/{orgId}/directories/{directoryId}/users`
      * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-get
      * @param params
      */
-    getDirectoryUsers: ({ orgId, directoryId, cursor, limit, accountIds, directoryIds, resourceIds, groupIds, claimStatus, status, accountStatus, membershipStatus, roleIds, searchTerm, sortBy }: {
+    getDirectoryUsers: ({ orgId, directoryId, cursor, limit, accountIds, directoryIds, resourceIds, groupIds, mfaEnabled, claimStatus, status, accountStatus, membershipStatus, roleIds, emailDomains, searchTerm, sortBy }: {
         /**
-         * 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;
         /**
@@ -61,6 +172,13 @@ export declare class UsersService extends CommonHttpService {
         resourceIds?: string[] | undefined;
         /** A list of group IDs. */
         groupIds?: string[] | undefined;
+        /**
+         * Whether or not a managed account has two-step verification enabled on their
+         * account. If `true`, they have two-step verification enabled.
+         * By default, all accounts are returned, regardless of two-step verification
+         * status.
+         */
+        mfaEnabled?: boolean | undefined;
         /**
          * The claim status for the user account. By default, both `managed` and
          * `unmanaged` accounts are returned.
@@ -78,8 +196,10 @@ export declare class UsersService extends CommonHttpService {
          *   - `not_invited` - `accountStatus` is `active` and `membershipStatus` is
          * `no_membership`.
          *   - `deactivated` - `accountStatus` is `inactive`.
+         *   - `for_deletion` - Indicates whether or not a managed account is scheduled
+         * for deletion.
          */
-        status?: ("active" | "suspended" | "not_invited" | "deactivated")[] | undefined;
+        status?: ("active" | "suspended" | "not_invited" | "deactivated" | "for_deletion")[] | undefined;
         /**
          * The lifecycle status of the account.
          *   - `active` - The account is active and can be used.
@@ -124,7 +244,13 @@ export declare class UsersService 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;
+        /**
+         * The email domain to filter the results. The email domain will be used to search
+         * against the  account email domain. For example, get all users with the
+         * `@atlassian.com` or `@example.com` email domain.
+         */
+        emailDomains?: string[] | undefined;
         /** A search term to search the `nickname` and `email` fields. */
         searchTerm?: string | undefined;
         /**
@@ -133,7 +259,7 @@ export declare class UsersService extends CommonHttpService {
          */
         sortBy?: ({
             /** The name of the field to sort the results by. */
-            field: "nick_name" | "email";
+            field: "nick_name";
             /** The direction to sort the results by. */
             direction: "asc" | "desc";
         } & {
@@ -142,16 +268,22 @@ export declare class UsersService extends CommonHttpService {
     }) => Promise<MultiDirectoryUserPage>;
     /**
      * Returns a count of users in an organization that match the supplied parameters.
+     * By default, users in all your directories and all your managed accounts are
+     * counted (including managed accounts that aren’t in a directory).
      *
-     * @returns Returned if the request is successful.
+     * To count users in a directory only, use the `directoryIds` field. To count your
+     * managed accounts, regardless if they’re in a directory or not, use the
+     * `claimStatus` field.
+     *
+     * @returns Success
      * @path GET `/v2/orgs/{orgId}/directories/{directoryId}/users/count`
      * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-count-get
      * @param params
      */
-    getDirectoryUsersCount: ({ orgId, directoryId, accountIds, directoryIds, resourceIds, groupIds, claimStatus, status, accountStatus, membershipStatus, roleIds, searchTerm }: {
+    getDirectoryUsersCount: ({ orgId, directoryId, accountIds, directoryIds, resourceIds, groupIds, mfaEnabled, claimStatus, status, accountStatus, membershipStatus, roleIds, searchTerm, emailDomains }: {
         /**
-         * 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;
         /**
@@ -175,6 +307,13 @@ export declare class UsersService extends CommonHttpService {
         resourceIds?: string[] | undefined;
         /** A list of group IDs. */
         groupIds?: string[] | undefined;
+        /**
+         * Whether or not a managed account has two-step verification enabled on their
+         * account. If `true`, they have two-step verification enabled.
+         * By default, all accounts are returned, regardless of two-step verification
+         * status.
+         */
+        mfaEnabled?: boolean | undefined;
         /**
          * The claim status for the user account. By default, both `managed` and
          * `unmanaged` accounts are returned.
@@ -192,8 +331,10 @@ export declare class UsersService extends CommonHttpService {
          *   - `not_invited` - `accountStatus` is `active` and `membershipStatus` is
          * `no_membership`.
          *   - `deactivated` - `accountStatus` is `inactive`.
+         *   - `for_deletion` - Indicates whether or not a managed account is scheduled
+         * for deletion.
          */
-        status?: ("active" | "suspended" | "not_invited" | "deactivated")[] | undefined;
+        status?: ("active" | "suspended" | "not_invited" | "deactivated" | "for_deletion")[] | undefined;
         /**
          * The lifecycle status of the account.
          *   - `active` - The account is active and can be used.
@@ -238,9 +379,15 @@ export declare class UsersService 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;
         /** A search term to search the `nickname` and `email` fields. */
         searchTerm?: string | undefined;
+        /**
+         * The email domain to filter the results. The email domain will be used to search
+         * against the  account email domain. For example, get all users with the
+         * `@atlassian.com` or `@example.com` email domain.
+         */
+        emailDomains?: string[] | undefined;
     }) => Promise<{
         /** The total number of users matching the criteria. */
         count?: number | undefined;
@@ -258,8 +405,8 @@ export declare class UsersService extends CommonHttpService {
      */
     getUserRoleAssignments: ({ orgId, directoryId, accountId, 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;
         /**
@@ -331,7 +478,7 @@ export declare class UsersService 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<MultiDirectoryUserRoleAssignmentPage>;
     /**
      * Returns a list of managed accounts in an organization.
@@ -343,25 +490,25 @@ export declare class UsersService extends CommonHttpService {
      */
     getUsers: ({ orgId, cursor }: {
         /**
-         * 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;
         /** Sets the starting point for the page of results to return. */
         cursor?: string | undefined;
     }) => Promise<UserPage>;
     /**
-     * Returns user stats for the organization.
+     * Return user stats for the organization.
      *
-     * @returns Returned if the request is successful.
+     * @returns Success
      * @path GET `/v2/orgs/{orgId}/directories/{directoryId}/users/stats`
      * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-stats-get
      * @param params
      */
     getUserStats: ({ 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;
         /**
@@ -372,6 +519,374 @@ export declare class UsersService extends CommonHttpService {
         directoryId: string;
     }) => Promise<MultiDirectoryUserStats>;
     /**
+     * **Additional response parameters of the API (for e.g., `added_to_org`) are
+     * available only to customers using the new user management experience.** 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).
+     *
+     * Specifications:
+     * - Return a user’s last active date for each product listed in Atlassian
+     * Administration.
+     * - Active is defined as viewing a product's page for a minimum of 2 seconds.
+     * - The data for the last activity may be delayed by up to 24 hours.
+     * - If the user has not accessed a product, the `product_access` response field
+     * will be empty.
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/user-last-active-dates/).
+     *
+     * @returns Successful operation
+     * @path GET `/v1/orgs/{orgId}/directory/users/{accountId}/last-active-dates`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-last-active-dates-get
+     * @param params
+     */
+    getV1OrgsOrgIdDirectoryUsersAccountIdLastActiveDates: ({ orgId, accountId, cursor }: {
+        /**
+         * 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 of the user's account.
+         * 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;
+        /** Cursor to fetch the next page */
+        cursor?: string | undefined;
+    }) => Promise<UserProductAccessActivityPage>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Restore user access in directory
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-accountid-restore-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:
+     * - Restore access of an existing user to products listed in Atlassian
+     * Administration.
+     * - Retract the suspend user action.
+     *
+     * This API will not:
+     * - Restore access to a user when they have 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.
+     * - Restore access to any user 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/restore-user/).
+     *
+     * @deprecated
+     * @returns User's access is successfully restored in the organization directory.
+     * @path POST `/v1/orgs/{orgId}/directory/users/{accountId}/restore-access`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-restore-access-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryUsersAccountIdRestoreAccess: ({ orgId, 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 of the user's account that you are suspending.
+         * 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
+         * Access to organization 6665kc2j-4644-14k8-j32c-68cc0b1d15b8 was restored for user 637194fa77acd224b33bfae3
+         */
+        message?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Suspend user access in directory
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-accountid-suspend-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).
+     *
+     * Specifications:
+     * - Suspend user access to products listed in Atlassian Administration while
+     * keeping the account active.
+     * - Make product licenses available for active users.
+     * - Maintain respective users in **Groups** for easy restoration.
+     *
+     * User access can be restored anytime via the [Restore access
+     * API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory/#api-v1-orgs-orgid-directory-users-accountid-restore-access-post)
+     *
+     * Learn the fastest way to call the API with a detailed
+     * [tutorial](https://developer.atlassian.com/cloud/admin/organization/suspend-user/).
+     *
+     * @deprecated
+     * @returns User was successfully suspended in the organization directory.
+     * @path POST `/v1/orgs/{orgId}/directory/users/{accountId}/suspend-access`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryUsersAccountIdSuspendAccess: ({ orgId, 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 of the user's account that you are suspending.
+         * 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
+         * Access to organization 6665kc2j-4644-14k8-j32c-68cc0b1d15b8 was suspended for user 637194fa77acd224b33bfae3
+         */
+        message?: string | undefined;
+    } & {
+        [key: string]: unknown;
+    }>;
+    /**
+     * **The API is presently accessible exclusively to customers who hold a paid
+     * subscription.**
+     *
+     * **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)**.
+     *
+     * This API will:
+     * - invite user to org and add them to the directory
+     * - assign a role for a given resource
+     * - send email if the sendNotification field is set true with optional custom
+     * message for the email
+     *
+     * This API will not:
+     * - add users to group
+     *
+     * @deprecated
+     * @returns Invitation successfully sent
+     * @path POST `/v1/orgs/{orgId}/users/invite`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-invite-post
+     * @param params
+     */
+    postV1OrgsOrgIdUsersInvite: ({ orgId, inviteApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        inviteApiRequest: InviteApiRequest;
+    }) => Promise<string[]>;
+    /**
+     * Assign an organization-level role to a user. These are roles that have
+     * organization-wide privileges, like organization admin.
+     *
+     * This operation follows eventual consistency. Changes may take up to 30 seconds
+     * to be reflected after the operation is performed.
+     *
+     * @path POST `/v1/orgs/{orgId}/users/{userId}/role-assignments/assign`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-role-assignments-assign-post
+     * @param params
+     */
+    postV1OrgsOrgIdUsersUserIdRoleAssignmentsAssign: ({ orgId, userId, organizationLevelRoleApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: 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).
+         */
+        userId: string;
+        organizationLevelRoleApiRequest: OrganizationLevelRoleApiRequest;
+    }) => Promise<void>;
+    /**
+     * Remove an organization-level role from a user. These are roles that have
+     * organization-wide privileges, like organization admin.
+     *
+     * This operation follows eventual consistency. Changes may take up to 30 seconds
+     * to be reflected after the operation is performed.
+     *
+     * @path POST `/v1/orgs/{orgId}/users/{userId}/role-assignments/revoke`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-role-assignments-revoke-post
+     * @param params
+     */
+    postV1OrgsOrgIdUsersUserIdRoleAssignmentsRevoke: ({ orgId, userId, organizationLevelRoleApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: 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).
+         */
+        userId: string;
+        organizationLevelRoleApiRequest: OrganizationLevelRoleApiRequest;
+    }) => Promise<void>;
+    /**
+     * Restore a user’s access in a directory to let them access apps again. They
+     * regain their roles and group memberships from before their access was
+     * suspended. We resume billing you for this user.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/restore`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-restore-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountIdRestore: ({ orgId, directoryId, 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;
+        /**
+         * 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>;
+    /**
+     * Suspend a user’s access in a directory to remove their access to apps
+     * temporarily. You’re not billed for a user when their access is suspended. They
+     * regain their roles and group memberships when you restore their access.
+     *
+     * @path POST `/v2/orgs/{orgId}/directories/{directoryId}/users/{accountId}/suspend`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-directories-directoryid-users-accountid-suspend-post
+     * @param params
+     */
+    postV2OrgsOrgIdDirectoriesDirectoryIdUsersAccountIdSuspend: ({ orgId, directoryId, 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;
+        /**
+         * 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>;
+    /**
+     * Invite people to your organization. When you invite someone:
+     * - they’re given app roles according to your invitation.
+     * - they’re added to directories based on apps in your invitation.
+     * - they’re added to groups according to your invitation.
+     * - they receive an email invitation if the `sendNotification` field is set to
+     * `true` and the `notificationText` field contains a message to include in the
+     * email invitation.
+     *
+     * **This API is only available to customers who have at least one paid
+     * subscription in their organization.**
+     *
+     * @returns
+     *  * status: 200, mediaType: application/json
+     *
+     *    Success
+     *
+     *  * status: 206, mediaType: application/json
+     *
+     *    At least one invitation failed
+     * @path POST `/v2/orgs/{orgId}/users/invite`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v2-orgs-orgid-users-invite-post
+     * @param params
+     */
+    postV2OrgsOrgIdUsersInvite: ({ orgId, multidirectoryInviteApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        multidirectoryInviteApiRequest: MultidirectoryInviteApiRequest;
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 206;
+        mediaType: "application/json";
+        body: MultidirectoryInviteSuccessResponse;
+    }>>;
+    /**
+     * **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)**.
+     *
+     * This API can be used to revoke Platform Roles from a user.
+     *
+     * @path POST `/v1/orgs/{orgId}/users/{userId}/roles/revoke`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users#api-v1-orgs-orgid-users-userid-roles-revoke-post
+     * @param params
+     */
+    revokeRole: ({ orgId, userId, roleApiRequest }: {
+        /**
+         * Your organization has a unique ID. Find this ID in your Atlassian
+         * Administration URL or when you create your API key.
+         */
+        orgId: string;
+        /**
+         * The UserId on which the action(Role Revoke) needs to happen. Use the [Search
+         * for users within an organization
+         * API](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v1-orgs-orgid-users-get)
+         * to get the userId.
+         */
+        userId: string;
+        roleApiRequest: RoleApiRequest;
+    }) => Promise<void>;
+    /**
+     * **This API is deprecated and will no longer work after June 30, 2026.** Use the
+     * [Get users in an organization
+     * endpoint](https://developer.atlassian.com/cloud/admin/organization/rest/api-group-users/#api-v2-orgs-orgid-directories-directoryid-users-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)**
@@ -379,6 +894,7 @@ export declare class UsersService extends CommonHttpService {
      * Returns a list of users within an organization, offering search functionality
      * through multiple parameters for more precise results.
      *
+     * @deprecated
      * @returns Organization found. Response contains user search results
      *
      * example: " users_search_response":
@@ -403,8 +919,8 @@ export declare class UsersService extends CommonHttpService {
      */
     searchUsers: ({ orgId, usersSearchRequest }: {
         /**
-         * 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;
         /**