Class AuthObjectValue

Namespace

BiExcellence.OpenBi.Api.AuthObjects

Assembly

BiExcellence.OpenBi.Api.Client.dll

An authorized value range for an AuthObject, granted to a user or organisation (Owner). It works like a filter range in SAP selection options: a sign, an operator and one or two values.

public sealed record AuthObjectValue : IAuthObjectValue

Inheritance

object

AuthObjectValue

Implements

IAuthObjectValue

Properties

AuthObjectId

The id of the AuthObject this value belongs to. Set from the route on write.

[JsonPropertyName("authObjectId")]
public string? AuthObjectId { get; init; }

Property Value

string

DimensionId

The technical name of the restricted characteristic - the DimensionId of the auth object. At runtime values are matched to dimensions by this field, not by AuthObjectId, and the server does not copy it from the object, so the caller has to set it.

[JsonPropertyName("dimensionId")]
public string? DimensionId { get; init; }

Property Value

string

High

The upper bound for BT and NB; unused by the other operators.

[JsonPropertyName("high")]
public string? High { get; init; }

Property Value

string

Id

The id of the value. Server-assigned (a GUID) on create when left empty.

[JsonPropertyName("id")]
public string? Id { get; init; }

Property Value

string

Low

The value the operator compares with; the lower bound for BT and NB.

[JsonPropertyName("low")]
public string? Low { get; init; }

Property Value

string

Opt

The SAP range operator - EQ, NE, BT, NB, GE, GT, LE, LT, SW, EW, CP, NP or TN.

[JsonPropertyName("opt")]
public string? Opt { get; init; }

Property Value

string

Owner

Who the value applies to: a user id (the username) or an organisation id. An organisation's values apply to every user linked to it. Usergroups are not matched.

[JsonPropertyName("owner")]
public string? Owner { get; init; }

Property Value

string

Sign

The SAP range sign: I to include the matching values, E to exclude them.

[JsonPropertyName("sign")]
public string? Sign { get; init; }

Property Value

string