spws
Version:
SharePoint Web Services Wrapper
28 lines (27 loc) • 1.18 kB
TypeScript
import { SpwsResponse } from "../../types";
interface Operation extends SpwsResponse {
data: {
success: boolean;
};
}
/**
* Updates information for the specified group. The API does not support changing the description (Microsoft docs are incorrect).
* @param oldGroupName A string that contains the old name of the group.
* @param groupName A string that contains the new name of the group.
* @param ownerIdentifier A string that contains the user name (DOMAIN\User_Alias) for the owner of the group.
* @param ownerType A string that specifies the type of owner, which can be either user or group.
* @param description A string that contains the description for the group.
* @link https://docs.microsoft.com/en-us/previous-versions/office/developer/sharepoint-services/ms774703(v=office.12)
* @example
* ```
* const res = await removeUserFromGroup("dev\\john.smith", "Site Owners")
* ```
*/
declare const updateGroupInfo: (params: {
oldGroupName: string;
groupName: string;
ownerIdentifier: string;
ownerType: "user" | "group";
webURL?: string;
}) => Promise<Operation>;
export default updateGroupInfo;