SP.UserCollection.removeByLoginName Method (sp.js)

  • Article

Removes the user with the specified login name.

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

SP.UserCollection.removeByLoginName()

Parameters

  • loginName
    The login name of the user to remove, as specified in the user's loginName property.

Return value

Undefined

REST resource endpoint

See UserCollection resource for more information.

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/removeByLoginName(loginName)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/sitegroups(groupid)/users/removeByLoginName(loginName)

Resource parameters

  • loginName
    The login name of the user to remove, as specified in the user's loginName property.