SP.UserCollection.removeById Method (sp.js)

  • Article

Removes the user with the specified ID.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

SP.UserCollection.removeById()

Parameters

  • id
    The ID of the user to remove, as specified in the user's id property.

Return value

Undefined

REST resource endpoint

See UserCollection resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/removeById(id)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/removeById(id)

Resource parameters

  • id
    The ID of the user to remove, as specified in the user's id property.