/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { FoundGroups, Group, PageBeanUserDetails } from '../models'; export interface AddUserToGroupRequest { groupname: string; request_body: { [key: string]: object; }; } export interface CreateGroupRequest { request_body: { [key: string]: object; }; } export interface FindGroupsRequest { accountId?: string; query?: string; exclude?: Array; maxResults?: number; userName?: string; } export interface GetGroupRequest { groupname: string; expand?: string; } export interface GetUsersFromGroupRequest { groupname: string; includeInactiveUsers?: boolean; startAt?: number; maxResults?: number; } export interface RemoveGroupRequest { groupname: string; swapGroup?: string; } export interface RemoveUserFromGroupRequest { groupname: string; accountId: string; username?: string; } /** * no description */ export declare class GroupsApi extends runtime.BaseAPI { /** * Adds a user to a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Add user to group */ addUserToGroupRaw(requestParameters: AddUserToGroupRequest): Promise>; /** * Adds a user to a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Add user to group */ addUserToGroup(requestParameters: AddUserToGroupRequest): Promise; /** * Creates a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Create group */ createGroupRaw(requestParameters: CreateGroupRequest): Promise>; /** * Creates a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Create group */ createGroup(requestParameters: CreateGroupRequest): Promise; /** * Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the `html` field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically *Showing X of Y matching groups*. The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list. * Find groups */ findGroupsRaw(requestParameters: FindGroupsRequest): Promise>; /** * Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the `html` field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically *Showing X of Y matching groups*. The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg). Anonymous calls and calls by users without the required permission return an empty list. * Find groups */ findGroups(requestParameters: FindGroupsRequest): Promise; /** * This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get group */ getGroupRaw(requestParameters: GetGroupRequest): Promise>; /** * This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users in a group. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get group */ getGroup(requestParameters: GetGroupRequest): Promise; /** * Returns all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get users from group */ getUsersFromGroupRaw(requestParameters: GetUsersFromGroupRequest): Promise>; /** * Returns all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get users from group */ getUsersFromGroup(requestParameters: GetUsersFromGroupRequest): Promise; /** * Deletes a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)). * Remove group */ removeGroupRaw(requestParameters: RemoveGroupRequest): Promise>; /** * Deletes a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* strategic [group](https://confluence.atlassian.com/x/24xjL)). * Remove group */ removeGroup(requestParameters: RemoveGroupRequest): Promise; /** * Removes a user from a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Remove user from group */ removeUserFromGroupRaw(requestParameters: RemoveUserFromGroupRequest): Promise>; /** * Removes a user from a group. **[Permissions](#permissions) required:** Site administration (that is, member of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Remove user from group */ removeUserFromGroup(requestParameters: RemoveUserFromGroupRequest): Promise; }