Class Role

Namespace

BiExcellence.OpenBi.Api.Roles

Assembly

BiExcellence.OpenBi.Api.Client.dll

A role: a named permission/content scope assignable to users, usergroups and organisations.

public sealed record Role : IRole

Inheritance

object

Role

Implements

IRole

Properties

Created

When the role was created; set by the server on insert.

[JsonPropertyName("created")]
public DateTimeOffset Created { get; init; }

Property Value

DateTimeOffset

Creator

The username of whoever created the role; filled with the caller's name when left empty on create.

[JsonPropertyName("creator")]
public string? Creator { get; init; }

Property Value

string

CustomAttributes

The values of the table attributes defined for roles, keyed by attribute name.

[JsonPropertyName("customAttributes")]
public Dictionary<string, JsonElement>? CustomAttributes { get; init; }

Property Value

Dictionary<string, JsonElement>

Description

A free-text description of the role.

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

Property Value

string

Id

The role id (a GUID); generated by the server when left empty on create.

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

Property Value

string

IsFavorite

Whether this is a user's personal favorites role - the role the legacy user creation sets up for a new user and assigns to that user only.

[JsonPropertyName("isFavorite")]
public bool IsFavorite { get; init; }

Property Value

bool

Name

The display name of the role.

[JsonPropertyName("name")]
public string? Name { get; init; }

Property Value

string

Type

What the role is used for. A role that carries a CMS website must be of type CMS; anything else is an ordinary content role.

[JsonPropertyName("type")]
public string? Type { get; init; }

Property Value

string