Class Usergroup

Namespace

BiExcellence.OpenBi.Api.Usergroups

Assembly

BiExcellence.OpenBi.Api.Client.dll

A usergroup: a named collection of users, granted permissions, roles, organisations and generic objects. This is where rights live - permissions attach to usergroups, never to a user directly.

public sealed record Usergroup : IUsergroup

Inheritance

object

Usergroup

Implements

IUsergroup

Properties

CustomAttributes

Additional attributes stored with the usergroup, keyed by attribute name, beyond the fixed fields.

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

Property Value

Dictionary<string, JsonElement>

Description

A free-text description of the usergroup.

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

Property Value

string

Id

The usergroup id, a GUID. Generated by the server when left unset on create.

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

Property Value

string

Inherited

Only from GetUserUsergroupsAsync with inherited: true where the user is in the group only through one of its organisations, so it cannot be removed from the user, false where it is assigned directly. null everywhere else, and ignored in a request body.

[JsonPropertyName("inherited")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public bool? Inherited { get; init; }

Property Value

bool?

IsSystemGroup

Whether this is one of the built-in groups the server creates itself (see UsergroupIds). Read-only: set by the server, ignored in a request body.

[JsonPropertyName("isSystemGroup")]
public bool IsSystemGroup { get; init; }

Property Value

bool

Name

The display name of the usergroup.

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

Property Value

string