Class UmbAuthContext

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

Hierarchy (View Summary, Expand)

UmbContextBase<UmbAuthContext>
- UmbAuthContext

Constructors

constructor

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

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`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 can emit multiple times if more than one request is made after the token has expired.

Accessors

authorizationSignal

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

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

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
Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

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:8713

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(): Promise<void>
Clears the token storage.

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

completeAuthorizationRequest

completeAuthorizationRequest(): Promise<void>
Completes the login flow.

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

consumeContext

consumeContext<BaseType = unknown, ResultType = BaseType>(
alias: string | UmbContextToken<BaseType, ResultType>,
callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType = unknown
- ResultType = 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:54

destroy

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

dispatchEvent

dispatchEvent(event: Event): boolean
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

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

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:272

getContext

getContext<BaseType = unknown, ResultType = BaseType>(
alias: string | UmbContextToken<BaseType, ResultType>,
): Promise<ResultType>
Type Parameters
- BaseType = unknown
- ResultType = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
Returns Promise<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:65

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:143

getLatestToken

getLatestToken(): Promise<string>
Gets the latest token from the Management API. If the token is expired, it will be refreshed.

NB! The user may experience being redirected to the login screen if the token is expired.

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}` } });
```
Memberof
UmbAuthContext
- Defined in src/packages/core/auth/auth.context.ts:175

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 openapi-typescript-codegen library.

Memberof
UmbAuthContext
Example: <caption>Using the default OpenAPI configuration</caption>
```
 	const defaultOpenApi = authContext.getOpenApiConfiguration();
 	OpenAPI.BASE = defaultOpenApi.base;
		OpenAPI.WITH_CREDENTIALS = defaultOpenApi.withCredentials;
		OpenAPI.CREDENTIALS = defaultOpenApi.credentials;
		OpenAPI.TOKEN = defaultOpenApi.token;
```
- Defined in src/packages/core/auth/auth.context.ts:248

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:290

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:282

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 serverUrl = authContext.getServerUrl();
	const token = await authContext.getLatestToken();
	const result = await fetch(`${serverUrl}/umbraco/management/api/v1/my-resource`, { headers: { Authorization: `Bearer ${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

linkLogin

linkLogin(provider: string): Promise<void>
Parameters
- provider: string
Returns Promise<void>
See
UmbAuthFlow#linkLogin
- Defined in src/packages/core/auth/auth.context.ts:298

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:103

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:20

provideContext

provideContext<R = unknown>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R = unknown
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:45

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Removes the event listener in target's event listener list with the same type, callback, and options.

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:8725

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:263

setInitialState

setInitialState(): Promise<void>
Sets the initial state of the auth flow.

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

signOut

signOut(): Promise<void>
Signs the user out by removing any tokens from the browser.

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

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:201

unlinkLogin

unlinkLogin(providerName: string, providerKey: string): Promise<boolean>
Parameters
- providerName: string
- providerKey: string
Returns Promise<boolean>
See
UmbAuthFlow#unlinkLogin
- Defined in src/packages/core/auth/auth.context.ts:307

validateToken

validateToken(): Promise<boolean>
Validates the token against the server and returns true if the token is valid.

Returns Promise<boolean>
True if the token is valid, otherwise false

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

Class UmbAuthContext

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UmbAuthContext

Properties

_host

ReadonlyisAuthorized

Remark

ReadonlyisInitialized

Remark

ReadonlytimeoutSignal

Remark

Accessors

authorizationSignal

Returns Subject<void>

controllerAlias

Returns UmbControllerAlias

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

clearTokenStorage

Returns Promise<void>

Memberof

completeAuthorizationRequest

Returns Promise<void>

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<ResultType>

Description

Memberof

getHostElement

Returns Element

getIsAuthorized

Returns boolean

getLatestToken

Returns Promise<string>

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

Memberof

getOpenApiConfiguration

Returns UmbOpenApiConfiguration

Remark

Memberof

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

getPostLogoutRedirectUrl

Returns string

getRedirectUrl

Returns string

getServerUrl

Returns string

Memberof

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

Example: <caption></caption>

getUmbControllers

Parameters

`Readonly`isAuthorized

`Readonly`isInitialized

`Readonly`timeoutSignal