@esri/arcgis-rest-portal
Version:
ArcGIS Online and Enterprise content and user helpers for @esri/arcgis-rest-request
29 lines (28 loc) • 911 B
TypeScript
import { IRequestOptions, IGroupAdd, IGroup } from "@esri/arcgis-rest-request";
export interface ICreateGroupOptions extends IRequestOptions {
group: IGroupAdd;
}
/**
* Create a new Group. See the [REST Documentation](https://developers.arcgis.com/rest/users-groups-and-items/create-group.htm) for more information.
*
* ```js
* import { createGroup } from "@esri/arcgis-rest-portal";
*
* createGroup({
* group: {
* title: "No Homers",
* access: "public"
* },
* authentication
* })
* .then(response)
* ```
*
* Note: The group name must be unique within the user's organization.
* @param requestOptions - Options for the request, including a group object
* @returns A Promise that will resolve with the success/failure status of the request
*/
export declare function createGroup(requestOptions: ICreateGroupOptions): Promise<{
success: boolean;
group: IGroup;
}>;