UserManagerServices.DeleteUsers Method

UserManagerServicesDeleteUsers Method

Ingeniux CMS Web Services API

Deletes a collection of Users. This will automatically remove their membership from their belonging User Groups too.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<string[]> DeleteUsers(
	UniqueObjectsDeleteParam data
)

Public Function DeleteUsers ( 
	data As UniqueObjectsDeleteParam
) As XHRServiceResponseGeneric(Of String())

public:
virtual XHRServiceResponseGeneric<array<String^>^>^ DeleteUsers(
	UniqueObjectsDeleteParam^ data
) sealed

abstract DeleteUsers : 
        data : UniqueObjectsDeleteParam -> XHRServiceResponseGeneric<string[]> 
override DeleteUsers : 
        data : UniqueObjectsDeleteParam -> XHRServiceResponseGeneric<string[]>

Parameters

data

Type: UniqueObjectsDeleteParam

Object containing the User Id (login name) of Users to be deleted

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "selectedIds": ["t", "INGENIUX%5Cabusbin"]
    }
}

Remarks

The items in "selectedIds" field are URI encoded User Ids

Return Value

Type: XHRServiceResponseGenericString

Array of User Ids of the Users that has been removed

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": ["t", "INGENIUX%5Cabusbin"]
}

Remarks

Non-existing Users will be ignored

Note that this operation will not automatically remove the integrated Users from their Membership Providers store.

The operation DeleteUsers(String) performs that task.

Reference

UserManagerServices Class

IngeniuxCMService Namespace