Interface IOAuthAccessToken

Namespace

BiExcellence.OpenBi.Api.Auth

Assembly

BiExcellence.OpenBi.Api.Client.dll

An OAuth2 bearer access token issued by POST /oauth/token.

public interface IOAuthAccessToken

Properties

AccessToken

The access token, a JWT, sent as Authorization: Bearer <token> on every other route. The login methods of OpenBiApiClientAuthExtensions attach it to the client already.

string AccessToken { get; init; }

Property Value

string

ExpiresIn

How long the token is valid, in seconds from when it was issued.

int ExpiresIn { get; init; }

Property Value

int

IdToken

OpenID Connect: who the user is, as a signed JWT for the app (aud is its client id) - returned by the authorization_code and refresh_token grants of an app that asked for the openid scope, null otherwise.

string? IdToken { get; init; }

Property Value

string

RefreshToken

What RefreshAccessTokenAsync(IOpenBiApiClient, string, string?, string?, string?, CancellationToken) takes for the next access token - returned by the password, negotiate, authorization_code and refresh_token grants, null for client_credentials, whose api key can simply ask again. Every use replaces it; keep the new one, because the old one used again revokes the grant.

string? RefreshToken { get; init; }

Property Value

string

Scope

What the token may do: the permission ids it was granted, space delimited, as openbi.<resource>.<read|write|delete> - the same ids the routes check. Null from a server older than 2026-09-24, which did not return it.

string? Scope { get; init; }

Property Value

string

TokenType

The token type, always Bearer.

string TokenType { get; init; }

Property Value

string