Interface IOAuthUserInfo

Namespace

BiExcellence.OpenBi.Api.Auth

Assembly

BiExcellence.OpenBi.Api.Client.dll

The authenticated user's basic profile information, from GET /oauth/userinfo.

public interface IOAuthUserInfo

Properties

Email

The user's email address, null when not set.

string? Email { get; init; }

Property Value

string

FamilyName

The user's last name, null when not set.

string? FamilyName { get; init; }

Property Value

string

GivenName

The user's first name, null when not set.

string? GivenName { get; init; }

Property Value

string

Name

The first and last name joined by a space, null when the user has neither.

string? Name { get; init; }

Property Value

string

PasswordChangeRequired

Whether the user is still on the password it was given and has to set one of its own before it gets anywhere. False from a server older than 2026-09-24, which did not report it.

bool PasswordChangeRequired { get; init; }

Property Value

bool

Subject

The username the token belongs to (sub) - the id that routes taking a user id, such as GetUserAsync(IOpenBiApiClient, string, CancellationToken), expect.

string Subject { get; init; }

Property Value

string