ReadonlyisObservable that emits true if the user is authorized, otherwise false.
ReadonlyisObservable that emits true when the auth context is initialized.
ReadonlytimeoutObservable 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.
Observable that acts as a signal for when the authorization state changes.
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.
Optionaloptions: boolean | AddEventListenerOptionsCallback method called when context is resolved.
Reference to the created Context Consumer Controller instance
Gets all registered auth providers.
A Promise with the reference to the Context Api Instance
Get the default OpenAPI configuration, which is set up to communicate with the Management API.
The default OpenAPI configuration
This is useful if you want to communicate with your own resources generated by the openapi-typescript-codegen library.
UmbAuthContext
const defaultOpenApi = authContext.getOpenApiConfiguration();
OpenAPI.BASE = defaultOpenApi.base;
OpenAPI.WITH_CREDENTIALS = defaultOpenApi.withCredentials;
OpenAPI.CREDENTIALS = defaultOpenApi.credentials;
OpenAPI.TOKEN = defaultOpenApi.token;
Get the server url to the Management API.
The server url to the Management API
UmbAuthContext
const serverUrl = authContext.getServerUrl();
OpenAPI.BASE = serverUrl;
const serverUrl = authContext.getServerUrl();
const token = await authContext.getLatestToken();
const result = await fetch(`${serverUrl}/umbraco/management/api/v1/my-resource`, { headers: { Authorization: `Bearer ${token}` } });
Initiates the login flow.
The provider to use for login. Default is 'Umbraco'.
Optionalredirect: booleanIf true, the user will be redirected to the login page.
OptionalusernameHint: stringThe username hint to use for login.
Optionalmanifest: ManifestAuthProviderThe manifest for the registered provider.
An Observable to observe from.
Callback method called when data is changed.
OptionalcontrollerAlias: null | UmbControllerAliasReference to the created Observer Controller instance.
The API instance to be exposed.
Reference to the created Context Provider Controller instance
This base provides the necessary for a class to become a context-api controller.