createGroup

Function

import { createGroup } from "@esri/arcgis-rest-groups";
//
createGroup({
  group: {
    title: "No Homers",
    access: "public"
  },
  authentication
})
  .then(response)

Create a new Group. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IGroupAddRequestOptions

Options for the request, including a group object

Available requestOptions

Property Type Notes
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.

fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.

group IGroupAdd
headers Optional Inherited

Additional Headers to pass into the request.

httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.

maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

params Optional Inherited IParams

Additional parameters to pass in the request.

portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to 'https://www.arcgis.com/sharing/rest'.

rawResponse Optional Inherited boolean

Return the raw response

Returns

Promise<{

group:
IGroup
success:
boolean
}> - A Promise that will resolve with the success/failure status of the request


Note: The group name must be unique within the user's organization.


Function defined in packages/arcgis-rest-groups/src/create.ts:35