Function: user.Delete

Deletes a User Object. Returns true if successfully deleted or if no such Object existed to begin with. Currently only accessible by the UI.

Syntax

{
	"method": "user.Delete",
	"params": {
		"id": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

AdvFuture<bool> Delete( AdvGuid id );

public Task<bool> DeleteAsync(Guid id, CancellationToken ct = default);

delete(id: string): Promise<boolean>;

Id of the User to delete.

True if successful or no User with the provided id found.

The caller does not have the required permissions to access the data. For additional information, see Data.Forbidden.

This method requires API write access.