Class OAuthUserInfo

Namespace

BiExcellence.OpenBi.Api.Auth

Assembly

BiExcellence.OpenBi.Api.Client.dll

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

public sealed record OAuthUserInfo : IOAuthUserInfo

Inheritance

object

OAuthUserInfo

Implements

IOAuthUserInfo

Constructors

OAuthUserInfo(string, string?, string?, string?, string?, bool)

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

public OAuthUserInfo(string Subject, string? Name, string? GivenName, string? FamilyName, string? Email, bool PasswordChangeRequired = false)

Parameters

Subject string

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

Name string

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

GivenName string

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

FamilyName string

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

Email string

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

PasswordChangeRequired bool

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.

Properties

Email

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

[JsonPropertyName("email")]
public string? Email { get; init; }

Property Value

string

FamilyName

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

[JsonPropertyName("family_name")]
public string? FamilyName { get; init; }

Property Value

string

GivenName

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

[JsonPropertyName("given_name")]
public string? GivenName { get; init; }

Property Value

string

Name

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

[JsonPropertyName("name")]
public 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.

[JsonPropertyName("password_change_required")]
public 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.

[JsonPropertyName("sub")]
public string Subject { get; init; }

Property Value

string