Function: rights.GetRules

Get active rules for a specific client or context.

Syntax

{
	"method": "rights.GetRules",
	"params": {
		"session": "...",
		"context": "...",
	},
	"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
}

AdvFuture<std::vector<RightsRule>> GetRules( std::optional<AdvString> session = std::nullopt
	 std::optional<std::vector<RightsTarget>> context = std::nullopt );

public Task<IList<RightsRule>> GetRulesAsync(string? session = null,
		IList<RightsTarget>? context = null,
		CancellationToken ct = default);

getRules(session?: string | undefined, context?: RightsTarget[] | undefined): Promise<RightsRule[]>;

Parameters

session : `string` optional

Session ID of a connection that defines the context indirectly.

context : `RightsTarget[]` optional

Context as list of rights targets.

Result : `RightsRule[]`

List of rules for the given context. The rules are returned sorted so that a local permission check can easily be performed by sequentially going through the list.

Remarks

This method requires API read access.