unshareItemWithGroup
Stop sharing an item with a group, either as an item owner, group admin or organization admin.
import { unshareItemWithGroup } from '@esri/arcgis-rest-portal';
unshareItemWithGroup({
id: "abc123",
groupId: "xyz987",
owner: "some-owner",
authentication: session
})
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
requestOptions Required | IGroupSharingOptions | Options for the request. |
Available requestOptions
Property | Type | Notes |
---|---|---|
string | Group identifier | |
Inherited | UserSession | A session representing a logged in user. |
Inherited | string | Unique identifier for the item. |
Optional | boolean | |
Optional Inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
Optional Inherited | function(input: RequestInfo, init: RequestInit) : Promise<Response> | The implementation of |
Optional Inherited | [key: string]: any | Additional Headers to pass into the request. |
Optional Inherited | boolean | Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS. |
Optional Inherited | HTTPMethods | The HTTP method to send the request with. |
Optional Inherited | number | If the length of a GET request's URL exceeds |
Optional Inherited | string | Item owner, if different from the authenticated user. |
Optional Inherited | IParams | Additional parameters to pass in the request. |
Optional Inherited | string | Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'. |
Optional Inherited | boolean | Return the raw response |
Returns
A Promise that will resolve with the data from the response.
Function defined in packages/arcgis-rest-portal/src/sharing/unshare-item-with-group.ts:31