Table of Contents

Class AuthObject

Namespace
BiExcellence.OpenBi.Api.AuthObjects
Assembly
BiExcellence.OpenBi.Api.Client.dll

An authorization object (a dimension of access control, e.g. "region" or "cost center"): a data-level authorization on one characteristic. Where a permission decides whether a route may be called, an auth object decides which rows come back from the source system. The permitted values are AuthObjectValue entries under it - an object with no values permits nothing.

public sealed record AuthObject : IAuthObject
Inheritance
object
AuthObject
Implements

Properties

Description

The display text of the auth object.

[JsonPropertyName("description")]
public string? Description { get; init; }

Property Value

string

DimensionId

The technical name of the characteristic (dimension) the object restricts. Once an auth object exists for it, opening a data provider with that dimension fails for a user who has no value for it.

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

Property Value

string

Id

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

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

Property Value

string