Function: user.Get ➁

Returns a filtered list of User Objects as a follow up to a previous Get call. Only for the UI the users will contain the password property though.

Syntax

{
	"method": "user.Get",
	"params": {
		"context": "...",
		"scroll": "...",
		"offset": "...",
		"limit": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}
AdvFuture<GetResult<User>> Get( AdvString context
	 EnumPaginationScroll scroll,
	 std::optional<int> offset = std::nullopt,
	 std::optional<int> limit = std::nullopt );
public Task<GetResult<User>> GetAsync(string context,
		EnumPaginationScroll scroll,
		long? offset = null,
		long? limit = null,
		CancellationToken ct = default);
getNext(context: string, scroll: EnumPaginationScroll, offset?: number | undefined, limit?: number | undefined): Promise<GetResultUser>;

Parameters

context : string

The context received within the last get result. Mandatory for subsequent get calls with pagination.

scroll : int (EnumPaginationScroll)

Scrolls through the result set with ‘Next’ or ‘Prev’. Used for pagination.

offset : int optional

Offset of the first Object in the result set that should be returned. Used for direct pagination.

limit : int optional

Maximum amount of Objects that should be returned. (Max : 100000)

Result : GetResult

Contains result objects and pagination info, if present.

Errors

Data.InvalidContext ≥wg 0.5.1

The provided context cannot be used for pagination.

Data.InvalidCursor ≥wg 0.5.1

The object referenced by the context cursor has been deleted. The entire pagination process needs to be restarted.

Remarks

This method requires API read access.

Only for the UI the returned users will contain the password property.