Table of Contents

Class Permission

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

A permission: a right that the REST routes check. It is granted by assigning it to a usergroup - never to a user directly - and every member of the group then holds it. Its id is also an OAuth2 scope.

public sealed record Permission : IPermission
Inheritance
object
Permission
Implements

Properties

Id

The permission id, as openbi.<resource>.<read|write|delete> - for example openbi.user.read. This is the id the routes check, the scope an access token carries and the value an API key's scope lists.

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

Property Value

string

Name

The display name of the permission.

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

Property Value

string