Class UmbAuthContext

This base provides the necessary for a class to become a context-api controller.

Hierarchy (View Summary)

UmbContextBase
- UmbAuthContext

Constructors

constructor

new UmbAuthContext(
    host: UmbControllerHost,
    serverUrl: string,
    backofficePath: string,
    isBypassed: boolean,
    keepUserLoggedIn?: boolean,
): UmbAuthContext
Parameters
- host: UmbControllerHost
- serverUrl: string
- backofficePath: string
- isBypassed: boolean
- keepUserLoggedIn: boolean = false
Returns UmbAuthContext
Overrides UmbContextBase.constructor
- Defined in src/packages/core/auth/auth.context.ts:129

Properties

_host

_host: UmbControllerHost

`Readonly`isAuthorized

isAuthorized: Observable<boolean> = ...

Observable that emits true if the user is authorized, otherwise false.

Remark

It will only emit when the authorization state changes.

`Readonly`isInitialized

isInitialized: Observable<void> = ...

Observable that emits true when the auth context is initialized.

Remark

It will only emit once and then complete itself.

`Readonly`keepUserLoggedIn

keepUserLoggedIn: boolean

Whether the server is configured to keep users logged in by auto-refreshing before session expiry. Provided by the backend via the keep-user-logged-in attribute on <umb-app>.

`Readonly`session$

session$: Observable<undefined | UmbAuthSession> = ...

`Readonly`timeoutSignal

timeoutSignal: Observable<void> = ...

Observable that acts as a signal and emits when the user has timed out, i.e. the token has expired. This can be used to show a timeout message to the user.

Remark

It will emit once per second, so it can be used to trigger UI updates or other actions when the user has timed out.

Accessors

authorizationSignal

get authorizationSignal(): Observable<void>
Observable that acts as a signal for when the authorization state changes.

Returns Observable<void>
An observable that emits when the authorization state changes.

Deprecated
Observe isAuthorized instead. Scheduled for removal in Umbraco 19.

Remark
It will emit once per second, so it can be used to trigger UI updates or other actions when the authorization state changes.
- Defined in src/packages/core/auth/auth.context.ts:110

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbContextBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

clearTokenStorage

clearTokenStorage(): void
Clears the in-memory session state.

Returns void
Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:551

completeAuthorizationRequest

completeAuthorizationRequest(): Promise<null | UmbTokenEndpointResponse>
Completes the login flow. This is called on the oauth_complete page to exchange the authorization code for tokens.

Returns Promise<null | UmbTokenEndpointResponse>
The token response timing, or null if no authorization was pending.
- Defined in src/packages/core/auth/auth.context.ts:318

configureClient

configureClient(client: Client): void
Configures a @hey-api/openapi-ts client for authenticated API calls. Sets baseUrl, credentials, auth header, and binds the default response interceptors (401 retry, error handling, notifications).
Parameters
- client: Client
  A @hey-api/openapi-ts client instance.
Returns void
Example
```
const authContext = await this.getContext(UMB_AUTH_CONTEXT);
authContext.configureClient(myClient);
// Now myClient automatically includes auth headers and interceptors
```
- Defined in src/packages/core/auth/auth.context.ts:645

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

destroy

destroy(): void
Returns void
Overrides UmbContextBase.destroy
- Defined in src/packages/core/auth/auth.context.ts:218

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getAuthProviders

getAuthProviders(
extensionsRegistry: UmbBackofficeExtensionRegistry,
): Observable<ManifestAuthProvider[]>
Gets all registered auth providers.
Parameters
- extensionsRegistry: UmbBackofficeExtensionRegistry
Returns Observable<ManifestAuthProvider[]>
- Defined in src/packages/core/auth/auth.context.ts:677

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbContextBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getIsAuthorized

getIsAuthorized(): boolean
Checks if the user is authorized. If Authorization is bypassed, the user is always authorized.

Returns boolean
True if the user is authorized, otherwise false.
- Defined in src/packages/core/auth/auth.context.ts:384

getLatestToken

getLatestToken(): Promise<string>
Gets the latest token from the Management API. With cookie auth, this returns '[redacted]' — the real token is in the httpOnly cookie. If the session has expired, it will attempt a refresh first.

Returns Promise<string>
The latest token from the Management API
Example: <caption>Using the latest token</caption>
```
  const token = await authContext.getLatestToken();
  const result = await fetch('https://my-api.com', { headers: { Authorization: `Bearer ${token}` } });
```
Deprecated
Use configureClient for @hey-api/openapi-ts clients or getOpenApiConfiguration for manual fetch calls. With cookie-based auth this always returns '[redacted]'. Scheduled for removal in Umbraco 19.
See
- configureClient for automatic token handling with @hey-api/openapi-ts clients.
- getOpenApiConfiguration for manual fetch calls with cookie-based auth.
Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:437

getOpenApiConfiguration

getOpenApiConfiguration(): UmbOpenApiConfiguration
Get the default OpenAPI configuration, which is set up to communicate with the Management API.

Returns UmbOpenApiConfiguration
The default OpenAPI configuration
Remark
This is useful if you want to communicate with your own resources generated by the @hey-api/openapi-ts library.

Memberof
UmbAuthContext
Example: <caption>Using the default OpenAPI configuration</caption>
```
const defaultOpenApi = authContext.getOpenApiConfiguration();
client.setConfig({
  base: defaultOpenApi.base,
  auth: defaultOpenApi.token,
});
```
- Defined in src/packages/core/auth/auth.context.ts:625

getPostLogoutRedirectUrl

getPostLogoutRedirectUrl(): string
Gets the post logout redirect url.

Returns string
The post logout redirect url, which is the backoffice path with the logout path appended.
- Defined in src/packages/core/auth/auth.context.ts:695

getRedirectUrl

getRedirectUrl(): string
Gets the authorized redirect url.

Returns string
The redirect url, which is the backoffice path.
- Defined in src/packages/core/auth/auth.context.ts:687

getServerUrl

getServerUrl(): string

Get the server url to the Management API.

Returns string

The server url to the Management API

Memberof

UmbAuthContext

Example: <caption>Using the server url</caption>

	const serverUrl = authContext.getServerUrl();
	OpenAPI.BASE = serverUrl;

Example: <caption></caption>

	const config = authContext.getOpenApiConfiguration();
	const result = await fetch(`${config.base}/umbraco/management/api/v1/my-resource`, {
		credentials: config.credentials,
		headers: { Authorization: `Bearer ${await config.token()}` },
	});

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbContextBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

isSessionValid

isSessionValid(): boolean
Checks if the current session is still valid.

Returns boolean
True if the session has not expired.
- Defined in src/packages/core/auth/auth.context.ts:508

linkLogin

linkLogin(provider: string): Promise<void>
Links the current user to the specified provider by redirecting to the link endpoint.
Parameters
- provider: string
  The provider to link to.
Returns Promise<void>
- Defined in src/packages/core/auth/auth.context.ts:703

makeAuthorizationRequest

makeAuthorizationRequest(
    identityProvider?: string,
    redirect?: boolean,
    usernameHint?: string,
    manifest?: ManifestAuthProvider,
): Promise<void>
Initiates the login flow.
Parameters
- identityProvider: string = 'Umbraco'
  The provider to use for login. Default is 'Umbraco'.
- Optionalredirect: boolean
  If true, the user will be redirected to the login page.
- OptionalusernameHint: string
  The username hint to use for login.
- Optionalmanifest: ManifestAuthProvider
  The manifest for the registered provider.
Returns Promise<void>
- Defined in src/packages/core/auth/auth.context.ts:230

makeRefreshTokenRequest

makeRefreshTokenRequest(): Promise<boolean>
Attempts to refresh the token using Web Locks to prevent concurrent refresh requests.

Returns Promise<boolean>
True if the refresh was successful, otherwise false.
- Defined in src/packages/core/auth/auth.context.ts:465

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbContextBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbContextBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

setInitialized

setInitialized(): void
Sets the auth context as initialized, which means that the auth context is ready to be used.

Returns void
Remark
This is used to let the app context know that the core module is ready, which means that the core auth providers are available.
- Defined in src/packages/core/auth/auth.context.ts:668

setInitialState

setInitialState(): Promise<void>
Sets the initial state of the auth flow. First asks existing tabs for their session via BroadcastChannel. If no peer responds, falls back to a server refresh.

Returns Promise<void>
- Defined in src/packages/core/auth/auth.context.ts:401

signOut

signOut(): Promise<void>
Signs the user out by revoking tokens and redirecting to the end session endpoint.

Returns Promise<void>
Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:572

timeOut

timeOut(): void
Handles the case where the user has timed out, i.e. the token has expired. This will clear the token storage and set the user as unauthorized.

Returns void
Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:562

unlinkLogin

unlinkLogin(loginProvider: string, providerKey: string): Promise<boolean>
Unlinks the current user from the specified provider.
Parameters
- loginProvider: string
- providerKey: string
Returns Promise<boolean>
- Defined in src/packages/core/auth/auth.context.ts:730

validateToken

validateToken(): Promise<boolean>
Forces a token refresh against the server (calls /token) and returns true if successful. Use this when you need to unconditionally refresh — e.g. session timeout keep-alive. For per-request token handling, prefer configureClient which skips the network call when the access token is still valid. Uses Web Locks to deduplicate concurrent refresh requests across tabs.

Returns Promise<boolean>
True if the refresh succeeded, otherwise false

Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:457

Class UmbAuthContext

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbAuthContext

Properties

_host

ReadonlyisAuthorized

Remark

ReadonlyisInitialized

Remark

ReadonlykeepUserLoggedIn

Readonlysession$

ReadonlytimeoutSignal

Remark

Accessors

authorizationSignal

Returns Observable<void>

Deprecated

Remark

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

clearTokenStorage

Returns void

Memberof

completeAuthorizationRequest

Returns Promise<null | UmbTokenEndpointResponse>

configureClient

Parameters

Returns void

Example

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getAuthProviders

Parameters

Returns Observable<ManifestAuthProvider[]>

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getIsAuthorized

Returns boolean

getLatestToken

Returns Promise<string>

Example: <caption>Using the latest token</caption>

Deprecated

See

Memberof

getOpenApiConfiguration

Returns UmbOpenApiConfiguration

Remark

Memberof

Example: <caption>Using the default OpenAPI configuration</caption>

getPostLogoutRedirectUrl

`Readonly`isAuthorized

`Readonly`isInitialized

`Readonly`keepUserLoggedIn

`Readonly`session$

`Readonly`timeoutSignal