@resolution/organizations-api-client 0.14.0

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

@@ -0,0 +1,637 @@
+import { CommonHttpService } from "../../core/CommonHttpService";
+import { type CreateGroupInput, type AddGroupMembershipInput, type GroupRoleAssignmentInput, type UserProductAccessActivityPage, type RoleApiRequest, type InviteApiRequest } from "../models/directory";
+/**
+ * Org Directory APIs
+ *
+ * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory
+ * @category Services
+ */
+export declare class DirectoryService extends CommonHttpService {
+    /**
+     * **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 is in limited availability and access. The development, release, and
+     * timing of any features or functionality described herein remain at the sole
+     * discretion of Atlassian and are subject to change. Please reach out to
+     * Atlassian support to get access to this API.**
+     *
+     * 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-directory#api-v1-orgs-orgid-users-userid-roles-assign-post
+     * @param params
+     */
+    assignRole: ({ orgId, userId, roleApiRequest }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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>;
+    /**
+     * **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 is in limited availability and access. The development, release, and
+     * timing of any features or functionality described herein remain at the sole
+     * discretion of Atlassian and are subject to change. Please reach out to
+     * Atlassian support to get access to this API.**
+     *
+     * 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.
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-groupid-roles-assign-post
+     * @param params
+     */
+    assignRoleToGroup: ({ orgId, groupId, groupRoleAssignmentInput }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-groupid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryGroupsGroupId: ({ orgId, groupId, forceIfNotEmpty }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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/).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-groupid-memberships-accountid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryGroupsGroupIdMembershipsAccountId: ({ orgId, groupId, accountId }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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/).
+     *
+     * @path DELETE `/v1/orgs/{orgId}/directory/users/{accountId}`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory#api-v1-orgs-orgid-directory-users-accountid-delete
+     * @param params
+     */
+    deleteV1OrgsOrgIdDirectoryUsersAccountId: ({ orgId, accountId }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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>;
+    /**
+     * **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-directory#api-v1-orgs-orgid-directory-users-accountid-last-active-dates-get
+     * @param params
+     */
+    getV1OrgsOrgIdDirectoryUsersAccountIdLastActiveDates: ({ orgId, accountId, cursor }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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>;
+    /**
+     * **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).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryGroups: ({ orgId, createGroupInput }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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/).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-groupid-memberships-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryGroupsGroupIdMemberships: ({ orgId, groupId, addGroupMembershipInput }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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/).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-users-accountid-restore-access-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryUsersAccountIdRestoreAccess: ({ orgId, accountId }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    /**
+     * **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/).
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-users-accountid-suspend-access-post
+     * @param params
+     */
+    postV1OrgsOrgIdDirectoryUsersAccountIdSuspendAccess: ({ orgId, accountId }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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 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 is in limited availability and access. The development, release, and
+     * timing of any features or functionality described herein remain at the sole
+     * discretion of Atlassian and are subject to change. Please reach out to
+     * Atlassian support to get access to this API.**
+     *
+     * 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
+     *
+     * @returns Invitation successfully sent
+     * @path POST `/v1/orgs/{orgId}/users/invite`
+     * @see https://developer.atlassian.com/cloud/admin/organization/rest/api-group-directory#api-v1-orgs-orgid-users-invite-post
+     * @param params
+     */
+    postV1OrgsOrgIdUsersInvite: ({ orgId, inviteApiRequest }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        orgId: string;
+        inviteApiRequest: InviteApiRequest;
+    }) => Promise<string[]>;
+    /**
+     * **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 is in limited availability and access. The development, release, and
+     * timing of any features or functionality described herein remain at the sole
+     * discretion of Atlassian and are subject to change. Please reach out to
+     * Atlassian support to get access to this API.**
+     *
+     * 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-directory#api-v1-orgs-orgid-users-userid-roles-revoke-post
+     * @param params
+     */
+    revokeRole: ({ orgId, userId, roleApiRequest }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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>;
+    /**
+     * **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 is in limited availability and access. The development, release, and
+     * timing of any features or functionality described herein remain at the sole
+     * discretion of Atlassian and are subject to change. Please reach out to
+     * Atlassian support to get access to this API.**
+     *
+     * 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.
+     *
+     * @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-directory#api-v1-orgs-orgid-directory-groups-groupid-roles-revoke-post
+     * @param params
+     */
+    revokeRoleToGroup: ({ orgId, groupId, groupRoleAssignmentInput }: {
+        /**
+         * Your organization is identified by a Unique ID. You get your organization ID
+         * and Organization API key simultaneously.
+         */
+        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;
+    }>;
+    protected static initialize(): void;
+}