Function: user.Set

Sets specific properties of a User Object. Currently only accessible by the UI.

Syntax

{
	"method": "user.Set",
	"params": {
		"id": "...",
		"props": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<bool> Set( AdvGuid id, AdvObject props );
public Task<bool> SetAsync(Guid id, IDictionary<string, object?> props, CancellationToken ct = default);
set(id: string, props: Map<string, Object>): Promise<boolean>;

Parameters

id : guid

Id of the User to modify.

props : value{}

List of properties that should be set. Property paths may be used as ids to address any partial aspect of the Object.

Result : bool

True if successful.

Errors

Data.Forbidden ≥wg 0.4.6

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

Remarks

This method requires API write access.

Currently only the UI has write access.